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

Better organize link checker ignores #831

Merged
merged 3 commits into from
Feb 19, 2024
Merged

Conversation

Eric-Arellano
Copy link
Collaborator

This adds the idea of "always ignored URLs", rather than making us repeat every file in which the URL appears. That has become necessary now that we have dev and historical API docs.

This PR also removes some stale ignores.

Copy link
Collaborator

@arnaucasau arnaucasau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea with this change!! One question, isn't it dangerous to ignore relative links and anchors (e.g., #id1)? We could have a file with the same name in different APIs that will be ignored unintentionally. I don't think this will happen in the API docs, but maybe with some anchors and section titles. What do you think?

@arnaucasau arnaucasau self-requested a review February 19, 2024 17:11
@Eric-Arellano
Copy link
Collaborator Author

isn't it dangerous to ignore relative links and anchors (e.g., #id1)?

I think it depends on the anchor. Certain highly generic ones like #id1 are a bad idea. The majority of the anchor ignores here are in dedicated file lists. I only globally ignored a few like #qiskit.utils.optionals.HAS_TESTTOOLS, which seem well scoped.

Copy link
Collaborator

@arnaucasau arnaucasau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. Maybe we could add a little comment below the // Always ignored URLs section to have it in mind, just in case. Apart from that, all looks good to me!! Thank you for the change, tested locally and works well too 👍

@Eric-Arellano Eric-Arellano merged commit 57ce086 into main Feb 19, 2024
4 checks passed
@Eric-Arellano Eric-Arellano deleted the EA/better-link-ignores branch February 19, 2024 17:52
frankharkins pushed a commit to frankharkins/documentation that referenced this pull request Jul 22, 2024
This adds the idea of "always ignored URLs", rather than making us
repeat every file in which the URL appears. That has become necessary
now that we have dev and historical API docs.

This PR also removes some stale ignores.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants