Skip to content

Commit

Permalink
docs: rewrite query docstring
Browse files Browse the repository at this point in the history
Makes the docstring for query a bit shorter & easier to
understand. Uses CMD & PY macros correctly. Closes #6
  • Loading branch information
mslw committed May 15, 2023
1 parent 9f1c925 commit f65fd16
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions datalad_redcap/query.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,16 @@ def export_instruments(self):
class Query(ValidatedInterface):
"""Query REDCap's API for available instruments (data entry forms)
Can be used to retrieve human-oriented labels and API-oriented names of
instruments (data entry forms) which can be exported from the project.
[PY: Returns a result record dictionary res in which "instruments" key
contains a list where each instrument is represented as a dictionary with
"instrument name" and "instrument_label" keys.][CMD: Displays a table with
results].
Can be used to retrieve human-oriented labels and API-oriented
names of instruments (data entry forms) which can be exported from
the project.
[PY: Returns a result record dictionary, in which ``instruments``
is a list of dictionaries, with ``instrument_name`` and
``instrument_label`` keys. PY]
[CMD: Displays a table with results. CMD]
"""

result_renderer = "tailored"
Expand Down

0 comments on commit f65fd16

Please sign in to comment.