8000 docs: copy-editing in advanced-usage.md · actions/setup-python@8f0ee16 · GitHub
[go: up one dir, main page]

Skip to content

Commit 8f0ee16

Browse files
committed
docs: copy-editing in advanced-usage.md
Signed-off-by: Stephen L. <lrq3000@gmail.com>
1 parent a119b92 commit 8f0ee16

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/advanced-usage.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ steps:
101101
- run: python my_script.py
102102
```
103103
104-
- **[x-ranges](https://github.com/npm/node-semver#x-ranges-12x-1x-12-)** to specify the latest stable version of Python (for specified major version):
104+
- **[x-ranges](https://github.com/npm/node-semver#x-ranges-12x-1x-12-)** to specify the latest stable version of Python (for the specified major version):
105105
106106
```yaml
107107
steps:
@@ -145,7 +145,7 @@ jobs:
145145
python-version: ${{ matrix.python-version }}
146146
- run: python my_script.py
147147
```
148-
More details on PyPy syntax can be found in the [Available versions of PyPy](#pypy) section.
148+
More details on the syntax for PyPy can be found in the [Available versions of PyPy](#pypy) section.
149149

150150
### Specifying multiple Python/PyPy versions
151151
The python-version input can get multiple python/pypy versions. The last specified version will be used as a default one.
@@ -205,7 +205,7 @@ jobs:
205205
206206
### Matrix Testing
207207
208-
Using `setup-python` it's possible to use [matrix syntax](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix) to install several versions of Python or PyPy:
208+
Using `setup-python` it's possible to use the [matrix syntax](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix) to install several versions of Python or PyPy:
209209

210210
```yaml
211211
jobs:
@@ -252,7 +252,7 @@ jobs:
252252

253253
## Using the `python-version-file` input
254254

255-
`setup-python` action can read Python or PyPy version from a version file. `python-version-file` input is used for specifying the path to the version file. If the file that was supplied to `python-version-file` input doesn't exist, the action will fail with error.
255+
`setup-python` action can read the Python or PyPy version from a version file. `python-version-file` input is used to specify the path to the version file. If the file that was supplied to `python-version-file` input doesn't exist, the action will fail with an error.
256256

257257
>In case both `python-version` and `python-version-file` inputs are supplied, the `python-version-file` input will be ignored due to its lower priority.
258258

@@ -289,7 +289,7 @@ steps:
289289
check-latest: true
290290
- run: python my_script.py
291291
```
292-
> Setting `check-latest` to `true` has performance implications as downloading `Python or PyPy` versions is slower than using cached versions.
292+
> Setting `check-latest` to `true` impacts performance as downloading `Python or PyPy` versions is slower than using cached versions.
293293

294294

295295
## Caching packages
@@ -383,7 +383,7 @@ steps:
383383

384384
### `python-version`
385385

386-
Using **python-version** output it's possible to get the precise Python or PyPy version installed by the action. This output is useful when the input `python-version` is given as a range (e.g. 3.8.0 - 3.12.0, 3.x, * ), but down the line you need to operate (such as in an `if:` statement) with the exact installed version (e.g. 3.12.0).
386+
Using **python-version** output, it's possible to get the precise Python or PyPy version installed by the action. This output is useful when the input `python-version` is given as a range (e.g. 3.8.0 - 3.12.0, 3.x, * ), but down the line you need to operate (such as in an `if:` statement) with the exact installed version (e.g. 3.12.0).
387387

388388
```yaml
389389
jobs:
@@ -400,7 +400,7 @@ jobs:
400400

401401
### `python-path`
402402

403-
**python-path** output is available with the absolute path of the Python or PyPy interpreter executable if you need it:
403+
**python-path** output is available to get the absolute path of the Python or PyPy interpreter executable:
404404

405405
```yaml
406406
jobs:
@@ -449,7 +449,7 @@ The `update-environment` flag defaults to `true`.
449449
With this setting, the action will add/update environment variables (e.g. `PATH`, `PKG_CONFIG_PATH`, `pythonLocation`) for Python or PyPy to just work out of the box.
450450

451451
If `update-environment` is set to `false`, the action will not add/update environment variables.
452-
This can prove useful if you want the only side-effect to be to ensure Python or PyPy is installed and rely on the `python-path` output to run executable.
452+
This can prove useful if you only want the side-effect to ensure that Python or PyPy is installed and rely on the `python-path` output to run the executable.
453453
Such a requirement on side-effect could be because you don't want your composite action messing with your user's workflows.
454454

455455
```yaml
@@ -469,7 +469,7 @@ Such a requirement on side-effect could be because you don't want your composite
469469

470470
- Preinstalled versions of Python in the tool cache on GitHub-hosted runners.
471471
- For detailed information regarding the available versions of Python that are installed, see [Supported software](https://docs.github.com/en/actions/reference/specifications-for-github-hosted-runners#supported-software).
472-
- For every minor version of Python, expect only the latest patch to be preinstalled.
472+
- For every minor versions of Python, expect only the latest patch to be preinstalled.
473473
- If `3.12.1` is installed for example, and `3.12.2` is released, expect `3.12.1` to be removed and replaced by `3.12.2` in the tool cache.
474474
- If the exact patch version doesn't matter to you, specifying just the major and minor versions will get you the latest preinstalled patch version. In the previous example, the version spec `3.12` will use the `3.12.2` Python version found in the cache.
475475
- Use `-dev` instead of a patch number (e.g., `3.14-dev`) to install the latest patch version release for a given minor version, *alpha and beta releases included*.
@@ -534,11 +534,11 @@ If you have a supported self-hosted runner and you would like to use `setup-pyth
534534

535535
### Linux
536536

537-
By default runner downloads and installs tools into the folder set up by `RUNNER_TOOL_CACHE` environment variable. The environment variable called `AGENT_TOOLSDIRECTORY` can be set to change this location for Linux self-hosted runners:
537+
By default, the runner downloads and installs tools into the folder set up by `RUNNER_TOOL_CACHE` environment variable. The environment variable called `AGENT_TOOLSDIRECTORY` can be set to change this location for Linux self-hosted runners:
538538
- In the same shell that your runner is using, type `export AGENT_TOOLSDIRECTORY=/path/to/folder`.
539539
- More permanent way of setting the environment variable is to create an `.env` file in the same directory as your runner and to add `AGENT_TOOLSDIRECTORY=/path/to/folder`. This ensures the variable is always set if your runner is configured as a service.
540540

541-
If you're using a non-default tool cache directory be sure that the user starti 4F46 ng the runner has write permission to the new tool cache directory. To check the current user and group that the runner belongs type `ls -l` inside the runner's root directory.
541+
If you're using a non-default tool cache directory be sure that the user starting the runner has write permission to the new tool cache directory. To check the current user and group that the runner belongs, type `ls -l` inside the runner's root directory.
542542

543543
The runner can be granted write access to any directory using a few techniques:
544544
- The user starting the runner is the owner, and the owner has write permission.

0 commit comments

Comments
 (0)
0