Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lint: Prefer cross-references to explicit anchor tags when possible #1082

Open
michael-wisely-gravwell opened this issue Aug 13, 2024 · 0 comments
Labels
Medium medium priority task other change or action, e.g. refactoring or configuration changes

Comments

@michael-wisely-gravwell
Copy link
Contributor

Task

What needs to be done?

Add a some kind of lint rule to complain when it sees <a> tags.

Why is this task needed?

Cross-references are a really useful feature in sphinx:

  • Tolerant to restructure
    • If pages move or change (or whatever), cross-references will automatically update, and links will remain intact.
  • Error checking
    • If a cross-reference is broken somehow (page is deleted, ref is misspelled), then sphinx/myst will complain about it. The tool will help you find broken links.

Any other comments?

Medium because I think using cross-references can save us some headaches down the road.

@michael-wisely-gravwell michael-wisely-gravwell added task other change or action, e.g. refactoring or configuration changes Medium medium priority labels Aug 13, 2024
@ashnwade ashnwade self-assigned this Aug 13, 2024
@ashnwade ashnwade added this to the next-patch milestone Aug 13, 2024
@ashnwade ashnwade removed their assignment Aug 13, 2024
@ashnwade ashnwade removed this from the next-patch milestone Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Medium medium priority task other change or action, e.g. refactoring or configuration changes
Projects
None yet
Development

No branches or pull requests

2 participants