reanahub / reana-client

REANA command-line client
http://reana-client.readthedocs.io/
MIT License
10 stars 44 forks source link

docs: autoload client methods and add missing parameter descriptions #669

Closed giuseppe-steduto closed 10 months ago

giuseppe-steduto commented 10 months ago

Configure Sphinx to autoload all the public methods from api.client and add a small descriptions of the parameters of a function where it was missing.

Closes #665.

codecov[bot] commented 10 months ago

Codecov Report

Merging #669 (5fc10fb) into master (c9cb332) will not change coverage. The diff coverage is n/a.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/reanahub/reana-client/pull/669/graphs/tree.svg?width=650&height=150&src=pr&token=b85cSEiOhs&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=reanahub)](https://app.codecov.io/gh/reanahub/reana-client/pull/669?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=reanahub) ```diff @@ Coverage Diff @@ ## master #669 +/- ## ======================================= Coverage 58.63% 58.63% ======================================= Files 24 24 Lines 2369 2369 ======================================= Hits 1389 1389 Misses 980 980 ``` | [Files Changed](https://app.codecov.io/gh/reanahub/reana-client/pull/669?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=reanahub) | Coverage Δ | | |---|---|---| | [reana\_client/api/client.py](https://app.codecov.io/gh/reanahub/reana-client/pull/669?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=reanahub#diff-cmVhbmFfY2xpZW50L2FwaS9jbGllbnQucHk=) | `44.76% <ø> (ø)` | |
giuseppe-steduto commented 10 months ago

Should we also add the return value to the docstrings of every function?

Done! However, it's not super detailed, as I thought that would in a way make the documentation too overloaded (kinda like an OpenAPI specification, especially since many functions return an endpoint response), so I wrote an "overview" of the return value in a more relaxed way. Do you think it's better?