Azure / Azure/azure-sdk-for-python

[pylint] docstring default/optional updates

Open
#40,031 0 comments 0 reactions 1 assignee Claimed by @l0lawrence View on GitHub
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

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.