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

Restore the JSON schema, add human-readable configuration #51

Merged
merged 3 commits into from
Jul 9, 2021

Conversation

krassowski
Copy link
Contributor

@krassowski krassowski commented Jul 9, 2021

Closes #24. This takes the best of both words:

  • keeps machine-readable configuration schema, making it easy to adapt it for settings validation (if we would want to do so in the future)
  • auto-generates human-readable configuration documentation roughly following the tabular format suggested in Where to put structured documentation now? #24 (comment) to match the current README of pyls-spyder plugin
  • checks validity of the schema and ensures the markdown and schema version remain in sync

In schema itself:

  • updated the keys with pylsp over pyls
  • fixed one incorrect type caught thanks to the schema validation
  • removed no longer needed pylsp.executable (it was only used in the vscode-client)

@krassowski krassowski force-pushed the add-configuration-and-schema branch from 26c41d4 to d08cd54 Compare July 9, 2021 17:34
@krassowski
Copy link
Contributor Author

Ready for review.

@krassowski krassowski requested a review from andfoy July 9, 2021 17:51
@raprocks
Copy link

raprocks commented Jul 9, 2021

haha was doing this locally. nciely done!

@krassowski
Copy link
Contributor Author

Feel very welcome to review and suggest improvements.

@andfoy
Copy link
Contributor

andfoy commented Jul 9, 2021

Thanks for tour help with this one!

@andfoy andfoy merged commit 87b76d7 into python-lsp:develop Jul 9, 2021
@raprocks
Copy link

raprocks commented Jul 9, 2021

nice.

@andfoy andfoy added this to the v1.1.1 milestone Jul 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Where to put structured documentation now?
3 participants