Azure / Azure/azure-sdk-for-python
[pylint] docstring default/optional updates
Open
pylint
- Dominant language
- Python
- Stars
- 5.6k
- Forks
- 3.4k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 193
Description
In docstrings we need to check that the signature and the docstring types are the same.
That means that if something is optional in the docstring, it should also be optional in the signature. If a parameter has a default value we need that value to be present in the docstring as well. this will improve our sphinx docs
Contributor guide
Assessment
This issue has not been assessed yet.