Skip to content

Commit 8b7a557

Browse files
committed
Rearrange docstrings for long lines
numpydoc has no guidance for how to handle a long parameter type line. Rearrange things slightly to move the type information to the parameter documentation instead. See numpy/numpydoc#87
1 parent 4bfdd94 commit 8b7a557

File tree

4 files changed

+18
-24
lines changed

4 files changed

+18
-24
lines changed

python/lsst/daf/butler/core/config.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -215,12 +215,11 @@ class Config(collections.abc.MutableMapping):
215215
216216
Parameters
217217
----------
218-
other : `str` or `Config` or `dict` or `lsst.resources.ResourcePath`
219-
or `pathlib.Path`
218+
other : various
220219
Other source of configuration, can be:
221220
222-
- (`str` or `lsst.resources.ResourcePath`) Treated as a URI to a
223-
config file. Must end with ".yaml".
221+
- (`str`, `lsst.resources.ResourcePath` or `pathlib.Path`)
222+
Treated as a URI to a config file. Must end with ".yaml".
224223
- (`Config`) Copies the other Config's values into this one.
225224
- (`dict`) Copies the values from the dict into this Config.
226225

python/lsst/daf/butler/core/datastore.py

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -378,10 +378,9 @@ def mexists(
378378
----------
379379
refs : iterable of `DatasetRef`
380380
The datasets to be checked.
381-
artifact_existence : `dict` of [`lsst.resources.ResourcePath`, `bool`],
382-
optional
383-
Mapping of datastore artifact to existence. Updated by this
384-
method with details of all artifacts tested. Can be `None`
381+
artifact_existence : `dict` [`lsst.resources.ResourcePath`, `bool`]
382+
Optional mapping of datastore artifact to existence. Updated by
383+
this method with details of all artifacts tested. Can be `None`
385384
if the caller is not interested.
386385
387386
Returns
@@ -671,10 +670,9 @@ def transfer_from(
671670
data store choose the most natural option for itself.
672671
If the source location and transfer location are identical the
673672
transfer mode will be ignored.
674-
artifact_existence : `dict` of [`lsst.resources.ResourcePath`, `bool`],
675-
optional
676-
Mapping of datastore artifact to existence. Updated by this
677-
method with details of all artifacts tested. Can be `None`
673+
artifact_existence : `dict` [`lsst.resources.ResourcePath`, `bool`]
674+
Optional mapping of datastore artifact to existence. Updated by
675+
this method with details of all artifacts tested. Can be `None`
678676
if the caller is not interested.
679677
680678
Raises

python/lsst/daf/butler/datastores/chainedDatastore.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -269,10 +269,9 @@ def mexists(
269269
----------
270270
refs : iterable of `DatasetRef`
271271
The datasets to be checked.
272-
artifact_existence : `dict` of [`lsst.resources.ResourcePath`, `bool`],
273-
optional
274-
Mapping of datastore artifact to existence. Updated by this
275-
method with details of all artifacts tested. Can be `None`
272+
artifact_existence : `dict` [`lsst.resources.ResourcePath`, `bool`]
273+
Optional mapping of datastore artifact to existence. Updated by
274+
this method with details of all artifacts tested. Can be `None`
276275
if the caller is not interested.
277276
278277
Returns

python/lsst/daf/butler/datastores/fileDatastore.py

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1351,10 +1351,9 @@ def _process_mexists_records(
13511351
all_required : `bool`
13521352
Flag to indicate whether existence requires all artifacts
13531353
associated with a dataset ID to exist or not for existence.
1354-
artifact_existence : `dict` of [`lsst.resources.ResourcePath`, `bool`],
1355-
optional
1356-
Mapping of datastore artifact to existence. Updated by this
1357-
method with details of all artifacts tested. Can be `None`
1354+
artifact_existence : `dict` [`lsst.resources.ResourcePath`, `bool`]
1355+
Optional mapping of datastore artifact to existence. Updated by
1356+
this method with details of all artifacts tested. Can be `None`
13581357
if the caller is not interested.
13591358
13601359
Returns
@@ -1418,10 +1417,9 @@ def mexists(
14181417
----------
14191418
refs : iterable of `DatasetRef`
14201419
The datasets to be checked.
1421-
artifact_existence : `dict` of [`lsst.resources.ResourcePath`, `bool`],
1422-
optional
1423-
Mapping of datastore artifact to existence. Updated by this
1424-
method with details of all artifacts tested. Can be `None`
1420+
artifact_existence : `dict` [`lsst.resources.ResourcePath`, `bool`]
1421+
Optional mapping of datastore artifact to existence. Updated by
1422+
this method with details of all artifacts tested. Can be `None`
14251423
if the caller is not interested.
14261424
14271425
Returns

0 commit comments

Comments
 (0)