Azure / Azure/azure-sdk-for-python
[pylint] docstring default/optional updates
Aperta
pylint
- Lingua principale
- Python
- Stelle
- 5.6k
- Fork
- 3.4k
- Merge medio
- 2g 2h
- PR unite (30g)
- 213
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Valutazione
Questa issue non è ancora stata valutata.