Skip to content

Commit 6e7e02a

Browse files
committed
Make clearer what happens if links:check fails & quote code name
1 parent e791417 commit 6e7e02a

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/changes/changes_1.6.0.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ This version of the PTB adds nox tasks to check links present in our documentati
88
links:list - List all the links within the documentation
99
links:check - Checks whether all links in the documentation are accessible
1010

11-
`links:check` is run in the CI `checks.yml`. If this step fails in the CI,
12-
please check the output & manually resolve the issues. There might be some cases
13-
where you need to update your doc/conf.py with specific values for the allowed
11+
`links:check` is run in the CI `checks.yml`. If this step fails in the CI, it will cause
12+
the build to break. Please check the output & manually resolve the issues. There might
13+
be some cases where you need to update your `doc/conf.py` with specific values for the allowed
1414
options for the [Linkcheck Builder](https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder).
1515

1616
We recommend the following values be added:

0 commit comments

Comments
 (0)