Skip to content
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.

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

parameters in docstring but not in method signature #2363

Closed
1 of 7 tasks
iscai-msft opened this issue Jan 12, 2024 · 1 comment
Closed
1 of 7 tasks

parameters in docstring but not in method signature #2363

iscai-msft opened this issue Jan 12, 2024 · 1 comment
Assignees

Comments

@iscai-msft
Copy link
Contributor

iscai-msft commented Jan 12, 2024

Right now, we have a number of parameters we document in the sphinx docstring, but don't expose as keyword-only on the method signature. The reason for this is because we wanted to let users know these values existed, but we also thought that 99% of users wouldn't care about them. Now, we have a new pylint rule requiring that if something is in the docstring, it has to be in the method signature. Below is a list of the kwargs this rule is affecting, and we'll check them off if we want to keep them in the docstring and add them to the method signature, and no check mark means we'll remove from the docstring

@kristapratico
Copy link
Member

kristapratico commented Jan 17, 2024

I opened this PR that targets the next versions of pylint and the pylint guidelines checker: #2350

It seems that almost all the new linting errors reference keywords in docstrings that are not in the method signatures. Has there already been a discussion about which ones we want to expose from that list?

cc @msyyc since it looks like you might have already started work on this issue

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

No branches or pull requests

3 participants