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.

Sign up for GitHub

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

Jump to bottom

improve formatting of parameter list in RTD #390

Merged
merged 1 commit into from
Jul 30, 2020
Merged

improve formatting of parameter list in RTD #390

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 12 additions & 6 deletions apstools/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1467,22 +1467,28 @@ def quantify_md_key_use(key=None, db=None, catalog_name=None, since=None, until=

PARAMETERS

key : str
key
*str* :
one of the metadata keys in a run's start document
(default: ``plan_name``)
db : object
db
*object* :
Instance of databroker v1 ``Broker`` or v2 ``catalog``
(default: see ``catalog_name`` keyword argument)
catalog_name : str
catalog_name
*str* :
Name of databroker v2 catalog, used when supplied ``db`` is ``None``.
(default: ``mongodb_config``)
since : str
since
*str* :
include runs that started on or after this ISO8601 time
(default: ``1995-01-01``)
until : str
until
*str* :
include runs that started before this ISO8601 time
(default: ``2100-12-31``)
query : dict
query
*dict* :
mongo query dictionary, used to filter the results
(default: ``{}``)

Expand Down