Applied suggestions from code review in jazzband#1862

Author: chrysle

README.md

@@ -1,23 +1,23 @@
-[![jazzband](https://jazzband.co/static/img/badge.svg)](https://jazzband.co/)
-[![pypi](https://img.shields.io/pypi/v/pip-tools.svg)](https://pypi.org/project/pip-tools/)
-[![pyversions](https://img.shields.io/pypi/pyversions/pip-tools.svg)](https://pypi.org/project/pip-tools/)
-[![pre-commit](https://results.pre-commit.ci/badge/github/jazzband/pip-tools/main.svg)](https://results.pre-commit.ci/latest/github/jazzband/pip-tools/main)
-[![buildstatus-gha](https://github.com/jazzband/pip-tools/workflows/CI/badge.svg)](https://github.com/jazzband/pip-tools/actions?query=workflow%3ACI)
-[![codecov](https://codecov.io/gh/jazzband/pip-tools/branch/main/graph/badge.svg)](https://codecov.io/gh/jazzband/pip-tools)
+[![jazzband][jazzband-image]](jazzband) 
+[![pypi][pypi-image]](pypi)
+[![pyversions][pyversions-image]](pyversions) 
+[![pre-commit][pre-commit-image]](pre-commit) 
+[![buildstatus-gha][buildstatus-gha-image]](buildstatus-gha) 
+[![codecov][codecov-image]](codecov) 
 
 # pip-tools = pip-compile + pip-sync
 
 A set of command line tools to help you keep your `pip`-based packages fresh,
 even when you've pinned them. You do pin them, right? (In building your Python application and its dependencies for production, you want to make sure that your builds are predictable and deterministic.)
 
-[![pip-tools overview for phase II](https://github.com/jazzband/pip-tools/raw/main/img/pip-tools-overview.svg)](https://github.com/jazzband/pip-tools/raw/main/img/pip-tools-overview.svg)
+[![pip-tools overview for phase II][pip-tools-overview]](pip-tools-overview)
 
 ## Installation
 
 Similar to `pip`, `pip-tools` must be installed in each of your project's
 [virtual environments](https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments):
 
-```
+```console
 $ source /path/to/venv/bin/activate
 (venv) $ python -m pip install pip-tools
 ```
@@ -62,7 +62,7 @@ or [flit](https://flit.pypa.io/).
 Suppose you have a 'foobar' Python application that is packaged using `Setuptools`,
 and you want to pin it for production. You can declare the project metadata as:
 
-```
+```toml
 [build-system]
 requires = ["setuptools", "setuptools-scm"]
 build-backend = "setuptools.build_meta"
@@ -82,7 +82,7 @@ want to pin it for production. You also want to pin your development tools
 in a separate pin file. You declare `django` as a dependency and create an
 optional dependency `dev` that includes `pytest`:
 
-```
+```toml
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -98,7 +98,7 @@ dev = ["pytest"]
 
 You can produce your pin files as easily as:
 
-```
+```console
 $ pip-compile -o requirements.txt pyproject.toml
 #
 # This file is autogenerated by pip-compile with Python 3.10
@@ -166,7 +166,7 @@ django
 
 Now, run `pip-compile requirements.in`:
 
-```
+```console
 $ pip-compile requirements.in
 #
 # This file is autogenerated by pip-compile with Python 3.10
@@ -199,7 +199,7 @@ To force `pip-compile` to update all packages in an existing
 To update a specific package to the latest or a specific version use the
 `--upgrade-package` or `-P` flag:
 
-```
+```console
 # only update the django package
 $ pip-compile --upgrade-package django
 
@@ -214,7 +214,7 @@ You can combine `--upgrade` and `--upgrade-package` in one command, to
 provide constraints on the allowed upgrades. For example to upgrade all
 packages whilst constraining requests to the latest version less than 3.0:
 
-```
+```console
 $ pip-compile --upgrade --upgrade-package 'requests<3.0'
 ```
 
@@ -223,7 +223,7 @@ $ pip-compile --upgrade --upgrade-package 'requests<3.0'
 If you would like to use _Hash-Checking Mode_ available in `pip` since
 version 8.0, `pip-compile` offers `--generate-hashes` flag:
 
-```
+```console
 $ pip-compile --generate-hashes requirements.in
 #
 # This file is autogenerated by pip-compile with Python 3.10
@@ -252,14 +252,14 @@ To output the pinned requirements in a filename other than
 multiple files, for example with different constraints on django to test a
 library with both versions using [tox](https://tox.readthedocs.io/en/latest/):
 
-```
+```console
 $ pip-compile --upgrade-package 'django<1.0' --output-file requirements-django0x.txt
 $ pip-compile --upgrade-package 'django<2.0' --output-file requirements-django1x.txt
 ```
 
 Or to output to standard output, use `--output-file=-`:
 
-```
+```console
 $ pip-compile --output-file=- > requirements.txt
 $ pip-compile - --output-file=- < requirements.in > requirements.txt
 ```
@@ -269,7 +269,7 @@ $ pip-compile - --output-file=- < requirements.in > requirements.txt
 Any valid `pip` flags or arguments may be passed on with `pip-compile`'s
 `--pip-args` option, e.g.
 
-```
+```console
 $ pip-compile requirements.in --pip-args "--retries 10 --timeout 30"
 ```
 
@@ -280,7 +280,7 @@ confusing consumers of your custom script you can override the update command
 generated at the top of requirements files by setting the
 `CUSTOM_COMPILE_COMMAND` environment variable.
 
-```
+```console
 $ CUSTOM_COMPILE_COMMAND="./pipcompilewrapper" pip-compile requirements.in
 #
 # This file is autogenerated by pip-compile with Python 3.10
@@ -340,7 +340,7 @@ pytz==2023.3
 Now compile the dev requirements and the `requirements.txt` file is used as
 a constraint:
 
-```
+```console
 $ pip-compile dev-requirements.in
 #
 # This file is autogenerated by pip-compile with Python 3.10
@@ -369,13 +369,13 @@ the dev environment.
 
 To install requirements in production stage use:
 
-```
+```console
 $ pip-sync
 ```
 
 You can install requirements in development stage by:
 
-```
+```console
 $ pip-sync requirements.txt dev-requirements.txt
 ```
 
@@ -385,7 +385,7 @@ You might use `pip-compile` as a hook for the [pre-commit](https://github.com/pr
 See [pre-commit docs](https://pre-commit.com/) for instructions.
 Sample `.pre-commit-config.yaml`:
 
-```
+```yaml
 repos:
     - repo: https://github.com/jazzband/pip-tools
     rev: 6.13.0
@@ -395,7 +395,7 @@ repos:
 
 You might want to customize `pip-compile` args by configuring `args` and/or `files`, for example:
 
-```
+```yaml
 repos:
     - repo: https://github.com/jazzband/pip-tools
     rev: 6.13.0
@@ -407,7 +407,7 @@ repos:
 
 If you have multiple requirement files make sure you create a hook for each file.
 
-```
+```yaml
 repos:
     - repo: https://github.com/jazzband/pip-tools
     rev: 6.13.0
@@ -447,7 +447,7 @@ or upgrade.
 **Be careful**: `pip-sync` is meant to be used only with a
 `requirements.txt` generated by `pip-compile`.
 
-```
+```console
 $ pip-sync
 Uninstalling flake8-2.4.1:
     Successfully uninstalled flake8-2.4.1
@@ -463,7 +463,7 @@ Successfully installed click-4.1
 To sync multiple `*.txt` dependency lists, just pass them in via command
 line arguments, e.g.
 
-```
+```console
 $ pip-sync dev-requirements.txt requirements.txt
 ```
 
@@ -472,7 +472,7 @@ Passing in empty arguments would cause it to default to `requirements.txt`.
 Any valid `pip install` flags or arguments may be passed with `pip-sync`'s
 `--pip-args` option, e.g.
 
-```
+```console
 $ pip-sync requirements.txt --pip-args "--no-cache-dir --no-deps"
 ```
 
@@ -562,3 +562,18 @@ versions as the required `pip` versions.
 | 6.4.0          | 21.2 - 21.3.\* | 3.6 - 3.10     |
 | 6.5.0 - 6.10.0 | 21.2 - 22.3.\* | 3.7 - 3.11     |
 | 6.11.0+        | 22.2+          | 3.7 - 3.11     |
+
+
+[jazzband]: https://jazzband.co/
+[jazzband-image]: https://jazzband.co/static/img/badge.svg
+[pypi]: https://pypi.org/project/pip-tools/
+[pypi-image]: https://img.shields.io/pypi/v/pip-tools.svg
+[pyversions]: https://pypi.org/project/pip-tools/
+[pyversions-image]: https://img.shields.io/pypi/pyversions/pip-tools.svg
+[pre-commit]: https://results.pre-commit.ci/latest/github/jazzband/pip-tools/main
+[pre-commit-image]: https://results.pre-commit.ci/badge/github/jazzband/pip-tools/main.svg
+[buildstatus-gha]: https://github.com/jazzband/pip-tools/actions?query=workflow%3ACI
+[buildstatus-gha-image]: https://github.com/jazzband/pip-tools/workflows/CI/badge.svg
+[codecov]: https://codecov.io/gh/jazzband/pip-tools
+[codecov-image]: https://codecov.io/gh/jazzband/pip-tools/branch/main/graph/badge.svg
+[pip-tools-overview]: https://github.com/jazzband/pip-tools/raw/main/img/pip-tools-overview.svg