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

Document internal flake8 plugin schema and configuration #57

Merged
merged 2 commits into from
Jul 24, 2021

Conversation

GerardoGR
Copy link
Contributor

Note-to-self: Take more time to read the comments from the maintainers. I spent 15 mins syncing manually the schema.json and the CONFIGURATION.md until I realized @krassowski already shared a script to do that automagically 😅

# from https://github.com/python-lsp/python-lsp-server#development
python scripts/jsonschema2md.py pylsp/config/schema.json CONFIGURATION.md

Closes #55

CONFIGURATION.md Outdated Show resolved Hide resolved
@krassowski krassowski added this to the v1.2.0 milestone Jul 14, 2021
@andfoy
Copy link
Contributor

andfoy commented Jul 21, 2021

@krassowski, is this one ready to merge?

@krassowski
Copy link
Contributor

Yes, it looks good to me, I tested most of these config optoins locally to make sure they work. I added one suggestion for improvement (note: committing in GitHub UI is not enough, this will need regenerating the md file, I can do that) but this can be also done in follow up PR if you were aiming to get this in and cut a release now.

@andfoy
Copy link
Contributor

andfoy commented Jul 21, 2021

No worries, we need to finish #53 before making the release

@ccordoba12 ccordoba12 changed the title docs: document internal flake8 plugin schema and configuration Document internal flake8 plugin schema and configuration Jul 24, 2021
@ccordoba12 ccordoba12 merged commit f18f7ee into python-lsp:develop Jul 24, 2021
@GerardoGR GerardoGR deleted the document-flake8-plugin branch July 25, 2021 09:00
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.

Is emanspeaks/pyls-flake8 the preferred plugin for flake8 linting?
4 participants