Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 6ee8233

Browse files
committedMay 28, 2022··
📚 [guide] Fix remaining links
1 parent 51b83d3 commit 6ee8233

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed
 

‎docs/guide.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ Here is a complete list of the project variables defined by this template:
269269
:::{note}
270270
The initial project version should be the latest release on [PyPI],
271271
or `0.0.0` for an unreleased package.
272-
See [The Release workflow] for details.
272+
See [The Release workflow](the-release-workflow) for details.
273273
:::
274274

275275
Your choices are recorded in the file `.cookiecutter.json` in the generated project,
@@ -520,7 +520,7 @@ src
520520

521521
`__main__.py`
522522

523-
: The [__main__] module defines the entry point for the command-line interface.
523+
: The [`__main__`][__main__] module defines the entry point for the command-line interface.
524524
The command-line interface is implemented using the [Click] library,
525525
and supports `--help` and `--version` options.
526526
When the package is installed,
@@ -779,7 +779,7 @@ one principled, the other pragmatic:
779779

780780
The first point is treated in detail in the following articles:
781781

782-
- [Should You Use Upper Bound Version Constraints?][schreiner constraints] and [Poetry Versions][schreiner versions] by Henry Schreiner
782+
- [Should You Use Upper Bound Version Constraints?][schreiner constraints] and [Poetry Versions][schreiner poetry] by Henry Schreiner
783783
- [Semantic Versioning Will Not Save You][schlawack semantic] by Hynek Schlawack
784784
- [Version numbers: how to use them?][gabor version] by Bernát Gábor
785785
- [Why I don't like SemVer anymore][cannon semver] by Brett Cannon
@@ -1739,7 +1739,7 @@ and the {{ HPC }} uses none of them.
17391739
### The Flake8 hook
17401740

17411741
[Flake8] is an extensible linter framework for Python.
1742-
For more details, see the section [Linting with Flake8].
1742+
For more details, see the section [Linting with Flake8](linting-with-flake8).
17431743

17441744
(the-isort-hook)=
17451745

@@ -1804,16 +1804,16 @@ and links to their lists of error codes.
18041804
- Find invalid Python code
18051805
- [F][pyflakes codes]
18061806
- - [pycodestyle]
1807-
- Enforce style conventions from `PEP 8`\_
1807+
- Enforce style conventions from [PEP 8]
18081808
- [E,W][pycodestyle codes]
18091809
- - [pep8-naming]
1810-
- Enforce naming conventions from `PEP 8`\_
1810+
- Enforce naming conventions from [PEP 8]
18111811
- [N][pep8-naming codes]
18121812
- - [pydocstyle] / [flake8-docstrings]
1813-
- Enforce docstring conventions from `PEP 257`\_
1813+
- Enforce docstring conventions from [PEP 257]
18141814
- [D][pydocstyle codes]
18151815
- - [flake8-rst-docstrings]
1816-
- Find invalid reStructuredText\_ in docstrings
1816+
- Find invalid [reStructuredText] in docstrings
18171817
- [RST][flake8-rst-docstrings codes]
18181818
- - [flake8-bugbear]
18191819
- Detect bugs and design problems
@@ -1915,7 +1915,7 @@ For example,
19151915
the plugin detects Python 2 constructs which have been removed in Python 3,
19161916
and likely bugs such as function arguments defaulting to empty lists or dictionaries.
19171917

1918-
[Error codes][flake8-bugbear-codes] are prefixed by `B` for "bugbear".
1918+
[Error codes][flake8-bugbear codes] are prefixed by `B` for "bugbear".
19191919

19201920
The {{ HPC }} also enables Bugbear's `B9` warnings,
19211921
which are disabled by default.
@@ -2087,13 +2087,13 @@ It manages the following dependencies:
20872087
- See also
20882088
- - Python
20892089
- `poetry.lock`
2090-
- [Managing Dependencies](managing-dependencies)
2090+
- [Managing dependencies](managing-dependencies)
20912091
- - Python
20922092
- `docs/requirements.txt`
20932093
- [Read the Docs](read-the-docs-integration)
20942094
- - Python
20952095
- `.github/workflows/constraints.txt`
2096-
- [Workflow constraints](workflow-constraints)
2096+
- [Constraints file](workflow-constraints)
20972097
- - GitHub Action
20982098
- `.github/workflows/*.yml`
20992099
- [GitHub Actions workflows](github-actions-workflows)

0 commit comments

Comments
 (0)
Please sign in to comment.