Skip to content

[pylint] docstring default/optional updates #40031

Open
@l0lawrence

Description

@l0lawrence

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

Activity

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

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions