Skip to content

Commit

Permalink
Capitalize python in readme and settings description (#167)
Browse files Browse the repository at this point in the history
  • Loading branch information
vinitaparasrampuria committed Oct 10, 2023
1 parent 8ef7d44 commit 5011180
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions README.md
Expand Up @@ -4,14 +4,14 @@ A Visual Studio Code extension with support for the `autopep8` formatter. The ex

Note:

- This extension is supported for all [actively supported versions](https://devguide.python.org/#status-of-python-branches) of the `python` language (i.e., python >= 3.8).
- The bundled `autopep8` is only used if there is no installed version of `autopep8` found in the selected `python` environment.
- This extension is supported for all [actively supported versions](https://devguide.python.org/#status-of-python-branches) of the Python language (i.e., Python >= 3.8).
- The bundled `autopep8` is only used if there is no installed version of `autopep8` found in the selected Python environment.
- Minimum supported version of `autopep8` is `1.7.0`.
- This extension is experimental. The plan is that it will eventually replace the `autopep8` formatting functionality of [the Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python).

## Usage

Once installed in Visual Studio Code, "autopep8" will be available as a formatter for python files. Please select "autopep8" (extension id:`ms-python.autopep8`) as the default formatter. You can do this either by using the context menu (right click on a open python file in the editor) and select "Format Document With...", or you can add the following to your settings:
Once installed in Visual Studio Code, "autopep8" will be available as a formatter for Python files. Please select "autopep8" (extension id:`ms-python.autopep8`) as the default formatter. You can do this either by using the context menu (right click on a open Python file in the editor) and select "Format Document With...", or you can add the following to your settings:

```json
"[python]": {
Expand All @@ -27,7 +27,7 @@ and change the following, if set:

### Format on save

You can enable format on save for python by having the following values in your settings:
You can enable format on save for Python by having the following values in your settings:

```json
"[python]": {
Expand All @@ -44,9 +44,9 @@ If you want to disable autopep8 formatter, you can [disable this extension](http

| Settings | Default | Description |
| ------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| autopep8.args | `[]` | Custom arguments passed to `autopep8`. E.g `"autopep8.args" = ["--global-config", "<file>"]` |
| autopep8.args | `[]` | Custom arguments passed to `autopep8`. E.g `"autopep8.args" = ["--global-config", "<file>"]` |
| autopep8.path | `[]` | Setting to provide custom `autopep8` executable. This will slow down formatting, since we will have to run `autopep8` executable every time or file save or open. Example 1: `["~/global_env/autopep8"]` Example 2: `["conda", "run", "-n", "lint_env", "python", "-m", "autopep8"]` |
| autopep8.interpreter | `[]` | Path to a python interpreter to use to run the linter server. When set to `[]`, the interpreter for the workspace is obtained from `ms-python.python` extension. If set to some path, that path takes precedence, and the Python extension is not queried for the interpreter |
| autopep8.interpreter | `[]` | Path to a Python interpreter to use to run the formatter server. When set to `[]`, the interpreter for the workspace is obtained from `ms-python.python` extension. If set to some path, that path takes precedence, and the Python extension is not queried for the interpreter |
| autopep8.importStrategy | `useBundled` | Setting to choose where to load `autopep8` from. `useBundled` picks autopep8 bundled with the extension. `fromEnvironment` uses `autopep8` available in the environment. |
| autopep8.showNotification | `off` | Setting to control when a notification is shown. |

Expand Down
4 changes: 2 additions & 2 deletions package.nls.json
@@ -1,12 +1,12 @@
{
"extension.description": "Formatting support for python files using `autopep8`.",
"extension.description": "Formatting support for Python files using `autopep8`.",
"command.restartServer": "Restart Server",
"settings.args.description": "Arguments passed in. Each argument is a separate string in the array.",
"settings.path.description": "When set to a path to `autopep8` binary, extension will use that for linting. NOTE: Using this option may slowdown linting.",
"settings.importStrategy.description": "Defines where `autopep8` is imported from. This setting may be ignored if `autopep8.path` is set.",
"settings.importStrategy.useBundled.description": "Always use the bundled version of `autopep8`.",
"settings.importStrategy.fromEnvironment.description": "Use `autopep8` from environment, fallback to bundled version only if `autopep8` not available in the environment.",
"settings.interpreter.description": "When set to a path to python executable, extension will use that to launch the server and any subprocess.",
"settings.interpreter.description": "When set to a path to Python executable, extension will use that to launch the server and any subprocess.",
"settings.showNotifications.description": "Controls when notifications are shown by this extension.",
"settings.showNotifications.off.description": "All notifications are turned off, any errors or warning are still available in the logs.",
"settings.showNotifications.onError.description": "Notifications are shown only in the case of an error.",
Expand Down

0 comments on commit 5011180

Please sign in to comment.