-
Notifications
You must be signed in to change notification settings - Fork 201
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
Errors in CONFIGURATION.md? #264
Comments
Thanks for taking a close look. I did not do not anything wrong here, but we could improve
|
I see. That make sense. I'd be happy to update the configuration file but I do so by updating pylsp/config/schema.json, right?
Agreed. However, I had assumed it should be |
Yes, that is preferred as it will then be in both schema.json and CONFIGURATION.md (after regenerating it). You could update the
Alternatively it could be added below the table. We implement it by by adding a comment field in python-lsp-server/scripts/jsonschema2md.py Lines 49 to 73 in 6501e9e
JSON schema can encode much more than the JSON data types can hold. "Understanding JSON Schema" is probably a good place to start https://json-schema.org/understanding-json-schema/reference/numeric.html#integer |
Thanks for the link. It is clearer now. Should [Aside: Is there any plans to include other third party plugins settings in schema.json. I'm thinking of Edit: Added another setting to a query. |
Yes, these suggestions sound good to me.
I think we could encourage plugins which are in separate repositories to add their schema in their repositories; we could make re-uisng the script for converting schema to markdown file easier, but I don't think that we should add those to schema.json in this repository (due to high risk of user confusion, changes between versions, what happens if someone forks the plugin and now you want to use a fork, etc). |
OK, I understand. I did not appreciate such concerns. |
pylsp.plugins.flake8.hangClosing
is of typeboolean
but the default value isnull
. Should it not betrue
orfalse
?pylsp.plugins.flake8.maxLineLength
is of typeinteger
but should it not benumber
(c.fpylsp.plugins.pycodestyle.maxLineLength
) or does it not matter?pylsp.plugins.flake8.indentSize
is of typeinteger
but should it not benumber
or does it not matter?pylsp.plugins.flake8.select
is of typestring array
but the default value isnull
. Should it not be[]
(c.fpylsp.plugins.pydocstyle.select
?pylsp.plugins.jedi.env_vars
is of typeobject
but the default value isnull
. Should it not be{}
?pylsp.plugins.pycodestyle.hangClosing
is of typeboolean
but the default value isnull
. Should it not betrue
orfalse
?pylsp.plugins.pycodestyle.indentSize
is of typeinteger
but should it not benumber
or does it not matter?pylsp.plugins.pydocstyle.convention
is of typestring
but the default value isnull
yet the allowed values are"None"
,"numpy"
or"pep257"
. Should it not be"None"
instead ofnull
.pylsp.rope.ropeFolder
is of typestring array
but the default value isnull
. Should it not be[]
?See also #263.
The text was updated successfully, but these errors were encountered: