-
Notifications
You must be signed in to change notification settings - Fork 308
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
Improving docstrings #6628
Comments
Some automatic generation is already done for the API/Client - https://github.com/rucio/documentation/blob/main/tools/run_in_docker/generate_client_api_docs.sh , but I do agree |
rdimaio
added a commit
to rdimaio/rucio
that referenced
this issue
Apr 23, 2024
…ucio#6628 Used the tool "codespell" to identify the typos.
rdimaio
added a commit
to rdimaio/rucio
that referenced
this issue
Apr 23, 2024
…ucio#6628 Used the tool "codespell" to identify the typos.
rdimaio
added a commit
to rdimaio/rucio
that referenced
this issue
Apr 23, 2024
…ucio#6628 Used the tool "codespell" to identify the typos.
bari12
pushed a commit
that referenced
this issue
May 6, 2024
…6628 Used the tool "codespell" to identify the typos.
bari12
pushed a commit
that referenced
this issue
May 6, 2024
…6628 Used the tool "codespell" to identify the typos.
Reopening as that was only an initial PR, there is still some extra work to be done |
maxnoe
pushed a commit
to maxnoe/rucio
that referenced
this issue
Jun 3, 2024
…ucio#6628 Used the tool "codespell" to identify the typos.
labkode
pushed a commit
to labkode/rucio
that referenced
this issue
Jun 26, 2024
…ucio#6628 Used the tool "codespell" to identify the typos.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Partly related to: rucio/documentation#287.
It seems like there is no single style for docstrings in Rucio, e.g.:
For the docstring blocks:
rucio/lib/rucio/api/vo.py
Line 32 in a7f97ed
rucio/lib/rucio/api/rule.py
Line 138 in a7f97ed
For returns:
:return:
, e.g.: https://github.com/rucio/rucio/blob/master/lib/rucio/common/didtype.py#L162:returns:
, e.g.: https://github.com/rucio/rucio/blob/master/lib/rucio/tests/common.py#L101For exceptions:
:raises
: https://github.com/rucio/rucio/blob/master/lib/rucio/common/config.py#L337:raises:
: https://github.com/rucio/rucio/blob/master/lib/rucio/api/rule.py#L224I think we should agree on:
The text was updated successfully, but these errors were encountered: