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

fix(internal/godocfx): use correct anchor links #3738

Merged
merged 2 commits into from Feb 25, 2021
Merged

Conversation

@tbpg
Copy link
Collaborator

@tbpg tbpg commented Feb 25, 2021

This works by pre-processing the package and generating all of the correct anchor links. Then, when converting an ID to a link, we check if the ID is listed in the map of anchors.

It's possible there will be some duplication between IDs. But, that is already an issue because there is no way to know which one is correct to link to. An alternative would be to set the anchor for any duplicated links to "" so they don't link at all. In practice, I don't think this is an issue. So, I left it as-is and we can revisit later if needed.

Fixes #3737.

@tbpg tbpg requested a review from codyoss Feb 25, 2021
@tbpg tbpg requested a review from googleapis/yoshi-go-admins as a code owner Feb 25, 2021
@google-cla google-cla bot added the cla: yes label Feb 25, 2021
Copy link
Member

@codyoss codyoss left a comment

LGTM!

@tbpg tbpg added the automerge label Feb 25, 2021
@gcf-merge-on-green gcf-merge-on-green bot merged commit 919039a into master Feb 25, 2021
3 checks passed
3 checks passed
@google-cla
cla/google All necessary CLAs are signed
@conventional-commit-lint-gcf
conventionalcommits.org
Details
@kokoro-team
kokoro Kokoro CI build successful
Details
@gcf-merge-on-green gcf-merge-on-green bot deleted the godocfx branch Feb 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

2 participants