Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: gabalafou <[email protected]>
  • Loading branch information
Carreau and gabalafou authored Oct 3, 2024
1 parent bd96c77 commit bff2591
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions tools/divergent_links.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
"""This script help checking inconsistent links.
That is to say, links that have the same title but link to the same place.
That is to say, links that have the same title but go to different places.
This is useful for screen-reader and accessibility devices, where the user may
say "Go to X", but is there are 2 links X this can be confusing.
say "Go to X", but if there are 2 links named "X" this creates ambiguity.
Example (links that have the same name, but different URL):
Expand Down Expand Up @@ -120,11 +120,13 @@ def duplicates(self):
else:
print(
"""
Check each page individually for incoherent links
Check page-wise link consistency
(links with the same name on the same page should go to the same URL)
python tools/divergent_links.py docs/_build/html/
Check all pages for global (and local) incoherent links
Check site-wide link consistency
(links with the same name across all pages should go the same URL)
python tools/divergent_links.py docs/_build/html/ --all
Expand Down

0 comments on commit bff2591

Please sign in to comment.