diff --git a/docs/advanced-usage.md b/docs/advanced-usage.md index 8ddbc8e..85c4bdb 100644 --- a/docs/advanced-usage.md +++ b/docs/advanced-usage.md @@ -21,7 +21,7 @@ ## Specifying a Python version -- If there is a specific version of Python that you need and you don't want to worry about any potential breaking changes due to patch updates (going from `3.7.5` to `3.7.6` for example), you should specify the **exact major, minor, and patch version** (such as `3.7.5`): +If there is a specific version of Python that you need and you don't want to worry about any potential breaking changes due to patch updates (going from `3.7.5` to `3.7.6` for example), you should specify the **exact major, minor, and patch version** (such as `3.7.5`): ```yaml steps: @@ -31,10 +31,11 @@ steps: python-version: '3.7.5' - run: python my_script.py ``` - - The only downside to this is that set-up will take a little longer since the exact version will have to be downloaded if the exact version is not already installed on the runner due to more recent versions. - - MSI installers are used on Windows for this, so runs will take a little longer to set up vs MacOS and Linux. -- You can specify **only a major and minor version** if you are okay with the most recent patch version being used: +- The only downside to this is that set-up will take a little longer since the exact version will have to be downloaded if the exact version is not already installed on the runner due to more recent versions. +- MSI installers are used on Windows for this, so runs will take a little longer to set up vs MacOS and Linux. + +You can specify **only a major and minor version** if you are okay with the most recent patch version being used: ```yaml steps: @@ -44,11 +45,11 @@ steps: python-version: '3.7' - run: python my_script.py ``` - - There will be a single patch version already installed on each runner for every minor version of Python that is supported. - - The patch version that will be preinstalled, will generally be the latest and every time there is a new patch released, the older version that is preinstalled will be replaced. - - Using the most recent patch version will result in a very quick setup since no downloads will be required since a locally installed version of Python on the runner will be used. +- There will be a single patch version already installed on each runner for every minor version of Python that is supported. +- The patch version that will be preinstalled, will generally be the latest and every time there is a new patch released, the older version that is preinstalled will be replaced. +- Using the most recent patch version will result in a very quick setup since no downloads will be required since a locally installed version of Python on the runner will be used. -- You can specify the version with **prerelease tag** to download and set up an accurate pre-release version of Python: +You can specify the version with **prerelease tag** to download and set up an accurate pre-release version of Python: ```yaml steps: @@ -59,7 +60,7 @@ steps: - run: python my_script.py ``` -- It's also possible to use **x.y-dev syntax** to download and set up the latest patch version of Python, alpha and beta releases included. (for specified major & minor versions): +It's also possible to use **x.y-dev syntax** to download and set up the latest patch version of Python, alpha and beta releases included. (for specified major & minor versions): ```yaml steps: @@ -70,7 +71,7 @@ steps: - run: python my_script.py ``` -- You can also use several types of ranges that are specified in [semver](https://github.com/npm/node-semver#ranges), for instance: +You can also use several types of ranges that are specified in [semver](https://github.com/npm/node-semver#ranges), for instance: - **[hyphen ranges](https://github.com/npm/node-semver#hyphen-ranges-xyz---abc)** to download and set up the latest available version of Python (includes both pre-release and stable versions): @@ -83,7 +84,7 @@ steps: - run: python my_script.py ``` - - **[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): +**[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): ```yaml steps: