Skip to content

Commit

Permalink
Improve DirectButler documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dhirving committed Jan 3, 2024
1 parent 12dc951 commit e2c3f13
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
14 changes: 11 additions & 3 deletions python/lsst/daf/butler/direct_butler.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,8 @@ class DirectButler(Butler): # numpydoc ignore=PR02
Notes
-----
Most users should call `DirectButler`.``create_from_config`` or the
top-level `Butler`.``from_config`` instead of using this constructor
directly.
Most users should call the top-level `Butler`.``from_config`` instead of
using this constructor directly.
"""

# This is __new__ instead of __init__ because we have to support
Expand Down Expand Up @@ -182,6 +181,11 @@ def create_from_config(
without_datastore : `bool`, optional
If `True` do not attach a datastore to this butler. Any attempts
to use a datastore will fail.
Notes
-----
Most users should call the top-level `Butler`.``from_config``
instead of using this function directly.
"""
if "run" in config or "collection" in config:
raise ValueError("Passing a run or collection via configuration is no longer supported.")
Expand Down Expand Up @@ -2361,6 +2365,7 @@ def _query_dimension_records(
return data_ids

_config: ButlerConfig
"""Configuration for this Butler instance."""

_registry: SqlRegistry
"""The object that manages dataset metadata and relationships
Expand All @@ -2384,3 +2389,6 @@ def _query_dimension_records(
"""

_registry_shim: RegistryShim
"""Shim object to provide a legacy public interface for querying via the
the ``registry`` property.
"""
1 change: 0 additions & 1 deletion python/lsst/daf/butler/remote_butler/_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ class RemoteButlerFactory:
server_url : `str`
The URL of the Butler server that RemoteButler instances created by
this factory will connect to.
http_client : `httpx.Client`, optional
The httpx connection pool that RemoteButler instances created by this
factory will use for making HTTP requests. If omitted, creates a new
Expand Down

0 comments on commit e2c3f13

Please sign in to comment.