Updating devcontainer.json and README.md #22984
Conversation
cwebster-99
added
debt
@karthiknadig There was mention of linting and formatting support in the description which I removed. The only other place was in the categories section which I think is ok to keep for search/filtering. Thoughts? |
cwebster-99
added
the
skip package*.json
package.json
Outdated
| @@ -1,7 +1,7 @@ | |||
| { | |||
| "name": "python", | |||
| "displayName": "Python", | |||
| "description": "IntelliSense (Pylance), Linting, Debugging (Python Debugger), code formatting, refactoring, unit tests, and more.", | |||
| "description": "IntelliSense (Pylance), Debugging (Python Debugger), refactoring, unit tests, and more.", | |||
There was a problem hiding this comment.
There is Linting and Formatting category below. We should remove that also right?
There was a problem hiding this comment.
Yeah I can remove those as well. Was thinking it might be beneficial for searching and filtering but I think it makes sense to remove.
There was a problem hiding this comment.
just a note for our future selves: at some point we may want to change this to frame this is a plugin that offers access points to many different extensions for intellisense, env management, linting, formatting, debugging etc.
There was a problem hiding this comment.
I was thinking on adding a section like this to the readme and mentioning the formatting, linting, etc. extensions because we currently only mention them in links at the end. Perhaps we could add it now and expand upon it?
Co-authored-by: Luciana Abud <[email protected]>
README.md
Outdated
| ## Extensibility | ||
|
|
||
| To further improve your Python development experience, you can install various extensions to extend functionality in various feature areas. These extensions are all optional and depend on your project configuration and preferences. | ||
|
|
||
| - [Python formatters](https://code.visualstudio.com/docs/python/formatting#_choose-a-formatter) | ||
| - [Python linters](https://code.visualstudio.com/docs/python/linting#_choose-a-linter) | ||
|
|
||
| If you encounter issues with any of the listed extensions, please file an issue in its corresponding repo. | ||
|
|
There was a problem hiding this comment.
@luabud @karthiknadig Thoughts on an "extensibility" section we can add to? Open to re-naming, re-wording, etc.!
- Adding the Python Debugger extension to the `devcontainer.json` extensions. - Small hygiene updates and removing mention of built linting and formatting support on `README.md`. --------- Co-authored-by: Luciana Abud <[email protected]>
- Adding the Python Debugger extension to the `devcontainer.json` extensions. - Small hygiene updates and removing mention of built linting and formatting support on `README.md`. --------- Co-authored-by: Luciana Abud <[email protected]>
devcontainer.jsonextensions.README.md.