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

Parameters should be documented #5

Open

jbuisine opened this issue May 1, 2021 · 0 comments

Labels

Member

jbuisine commented May 1, 2021

Functions' parameters does not have enough explanations, as in example : https://github.com/prise-3d/rawls_api/blob/devel/api.py#L152

If you later want to auto-generate API documentation, no description will be produced for parameters.

jbuisine added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment