Skip to content

Commit

Permalink
Include advanced query system objects in docs
Browse files Browse the repository at this point in the history
`Butler.query` has been public for a while, but the documentation for the `Query` object it returns was not included in the documentation.

This change pulls in the user-facing portions of the interface without any of the internal objects.  (The internal objects are sometimes referenced from constructors, but those constructors are documented as "do not use".)
  • Loading branch information
dhirving committed Oct 16, 2024
1 parent 4ff6cc6 commit 6c25146
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 2 deletions.
22 changes: 22 additions & 0 deletions doc/lsst.daf.butler/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,17 @@ Python API reference
:no-inherited-members:
:skip: RegistryConfig

Advanced query system
---------------------

.. automodapi:: lsst.daf.butler.queries
:headings: ^"
:no-main-docstr:

.. automodapi:: lsst.daf.butler.queries.expression_factory
:headings: ^"
:no-main-docstr:

Example datastores
------------------

Expand Down Expand Up @@ -173,6 +184,17 @@ Datastore utilities
:headings: ^"
:skip: Datastore

Advanced query system internals
-------------------------------

.. automodapi:: lsst.daf.butler.queries.tree
:no-main-docstr:
:no-inherited-members:
:headings: ^"
:include: Predicate
:skip: DataCoordinateUploadKey
:skip: MaterializationKey

Registry utilities and interfaces
---------------------------------

Expand Down
3 changes: 2 additions & 1 deletion python/lsst/daf/butler/queries/_query.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ class Query(QueryBase):
Notes
-----
`Query` objects should never be constructed directly by users; use
`Butler._query` instead.
`Butler.query` instead.
A `Query` object represents the first stage of query construction, in which
constraints and joins are defined (roughly corresponding to the WHERE and
Expand Down Expand Up @@ -135,6 +135,7 @@ def constraint_dimensions(self) -> DimensionGroup:
@property
def expression_factory(self) -> ExpressionFactory:
"""A factory for column expressions using overloaded operators.
(`~lsst.daf.butler.queries.expression_factory.ExpressionFactory`).
Notes
-----
Expand Down
1 change: 0 additions & 1 deletion python/lsst/daf/butler/queries/tree/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,5 @@
from ._query_tree import *

LogicalNot.model_rebuild()
del LogicalNot

Predicate.model_rebuild()

0 comments on commit 6c25146

Please sign in to comment.