chore: centralising the documentation #155
Conversation
uriii3
force-pushed
the
documenting
branch
3 times, most recently
from
db7e99e to
fe1022a
Compare
|
With the rework, I will take care of the definitions of the variables are kept the same. The only missing thing, for the moment, is the description of the functions and the response description too. Don't know if it is worth, too, to implement a check on those. I will review the documentation with the word once again to check that all the changes are kept the same and properly. |
check back some updates finalising the dictionary should work for the subset all python api interface documentation updated Trying to see if this will work check back some updates finalising the dictionary should work for the subset all python api interface documentation updated all cli documentation update all cli documentation update order of decorators add description and response parts, version updates delete example ready to rebase coords selection method docs last changes mainly and will correct tests and main revision some updates on the docstrings documentation updated Some tests on the matter add numpydoc updating snapshots description changes Error in the describe delete one file first batch of changes check with r changes after comments on pr
| request_file : Union[pathlib.Path, str], optional | ||
| Path to a file containing request parameters. For more information, please refer to the README. | ||
| Option to pass a file containing the arguments. For more information please refer to the documentation or use option ``--create-template`` for an example template. |
There was a problem hiding this comment.
Heey, here I used the same description as in the subset but the option create template definitely doesn't exist for the get. Do you have any idea on how we could rewrite this option to be able to explain the request_file without the create template?
There was a problem hiding this comment.
It definitely exists
There was a problem hiding this comment.
not in the API though, no?
There was a problem hiding this comment.
True! I guess you could just say: documentation or use option ``--create-template`` from the command line interface for an example template
|
Only remaining:
Basically my last two comments and update snapshots before merging! |
Co-authored-by: Renaud <[email protected]> Refactoring to try to centralise as much as possible the documentation. Rewording some definitions and adding some documentation were necessary.
Co-authored-by: Renaud <[email protected]> Refactoring to try to centralise as much as possible the documentation. Rewording some definitions and adding some documentation were necessary.
We wanted to have all the descriptions (helps) of the variables the same way and easy to change: to do so, we centralise the documentation of the variables in a single code.