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

Improve linting and formatting docs #22709

Closed
luabud opened this issue Jan 3, 2024 · 4 comments
Closed

Improve linting and formatting docs #22709

luabud opened this issue Jan 3, 2024 · 4 comments
Assignees
Labels
area-formatting area-linting debt Covers everything internal: CI, testing, refactoring of the codebase, etc. documentation

Comments

@luabud
Copy link
Member

luabud commented Jan 3, 2024

This is to track handling the feedback we've been receiving regarding https://code.visualstudio.com/docs/python/linting and https://code.visualstudio.com/docs/python/formatting.

@luabud luabud added debt Covers everything internal: CI, testing, refactoring of the codebase, etc. needs proposal Need to make some design decisions documentation labels Jan 3, 2024
@luabud luabud self-assigned this Jan 3, 2024
@luabud luabud added this to the December / January 2024 milestone Jan 3, 2024
@luabud luabud self-assigned this Jan 3, 2024
@rootsmusic
Copy link

rootsmusic commented Jan 3, 2024

These docs say "Choose a linter" or "Choose a formatter". However, I believe that choosing multiple linters isn't unadvised (some third-party linters combine Pylint, flake8 and mypy). I think the same is true with isort and black formatter.

@luabud
Copy link
Member Author

luabud commented Jan 4, 2024

That's a good point, we can improve the framing there to make it clearer that you can use tools side by side.

@rootsmusic
Copy link

rootsmusic commented Jan 4, 2024

Integrate wiki page. Which ones support the vscode-jupyter extension?

@luabud
Copy link
Member Author

luabud commented Jan 19, 2024

We're tracking this issue for adding support for notebooks: #21142
Right now none of them offer complete support by default. I think Ruff offers some support at the moment.

I'm closing this issue here as fixed by microsoft/vscode-docs#6960 😊

@luabud luabud closed this as completed Jan 19, 2024
@github-actions github-actions bot removed the needs proposal Need to make some design decisions label Jan 19, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 4, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-formatting area-linting debt Covers everything internal: CI, testing, refactoring of the codebase, etc. documentation
Projects
None yet
Development

No branches or pull requests

2 participants