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.

Sign up for GitHub

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

Jump to bottom

List of allowed values for pylsp.plugins.pydocstyle.convention in CONFIGURATION.md incorrect #292

Closed
doolio opened this issue Nov 4, 2022 · 2 comments · Fixed by #295
Closed

List of allowed values for pylsp.plugins.pydocstyle.convention in CONFIGURATION.md incorrect #292

doolio opened this issue Nov 4, 2022 · 2 comments · Fixed by #295
Milestone
v1.7.0

Comments

@doolio
Copy link
Contributor

doolio commented Nov 4, 2022

The CONFIGURATION suggests possible string values for pylsp.plugins.pydocstyle.convention are "pep257", "numpy", and "None" but the official documentation states the allowed values are in fact "pep257", "numpy", and "google".
@krassowski
Copy link
Contributor

krassowski commented Nov 4, 2022 •
edited
Loading

"google" is only available since version 4.0.0 (https://www.pydocstyle.org/en/stable/release_notes.html#july-6th-2019) does pylsp already support it?

Edit: it seems the answer is yes, so the enum should be updated:

python-lsp-server/pyproject.toml

Line 34 in b24ffd3

"pydocstyle>=2.0.0",

@doolio doolio mentioned this issue Nov 5, 2022
Merged
@doolio
Copy link
Contributor Author

doolio commented Nov 5, 2022

OK, PR #295 submitted for consideration.

@ccordoba12 ccordoba12 added this to the v1.7.0 milestone Nov 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v1.7.0
Development

Successfully merging a pull request may close this issue.

Update allowed values for pydocstyle convention in CONFIGURATION.md
3 participants
@ccordoba12 @krassowski @doolio