Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DM-34141: clarify DimensionPacker documentation #913

Merged
merged 1 commit into from
Nov 30, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions python/lsst/daf/butler/dimensions/_packer.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ class DimensionPacker(metaclass=ABCMeta):
fixed : `DataCoordinate`
Expanded data ID for the dimensions whose values must remain fixed
(to these values) in all calls to `pack`, and are used in the results
of calls to `unpack`. Subclasses are permitted to require that
``fixed.hasRecords()`` return `True`.
of calls to `unpack`. Subclasses may ignore particular dimensions, and
are permitted to require that ``fixed.hasRecords()`` return `True`.
dimensions : `DimensionGroup` or `DimensionGraph`
The dimensions of data IDs packed by this instance. Only
`DimensionGroup` will be supported after v27.
Expand Down Expand Up @@ -124,12 +124,13 @@ def pack(
dataId : `DataId`
Data ID to pack. Values for any keys also present in the "fixed"
data ID passed at construction must be the same as the values
passed at construction.
passed at construction, but in general you must still specify
those keys.
returnMaxBits : `bool`
If `True`, return a tuple of ``(packed, self.maxBits)``.
**kwargs
Additional keyword arguments forwarded to
`DataCoordinate.standardize`.
Additional keyword arguments are treated like additional key-value
pairs in ``dataId``.

Returns
-------
Expand Down
Loading