Ignore knownTypes for local types#197
Open
stephenfin wants to merge 2 commits intoelastic:masterfrom
Open
Conversation
|
💚 CLA has been signed |
Signed-off-by: Stephen Finucane <stephen@that.guru>
knownTypes entries were being applied to all types regardless of whether they were local to the source package or imported from another package. This caused local types that appeared in knownTypes to be rendered with external links rather than local anchor links, breaking in-page navigation when rendered locally. Move the lookup inside the IsBasic/Imported branch so that it only applies to types that cannot resolve to a local anchor. Signed-off-by: Stephen Finucane <stephen@that.guru>
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
knownTypesentries were being applied to all types regardless of whether they were local to the source package or imported from another package. This caused local types that appeared inknownTypesto be rendered with external links rather than local anchor links, breaking in-page navigation when rendered locally.Move the
knownTypeslookup inside theIsBasic/Importedbranch so that it only applies to types that cannot resolve to a local anchor.This was spotted while attempting to migrate https://github.com/kubernetes-sigs/cluster-api-provider-openstack from https://github.com/ahmetb/gen-crd-api-reference-docs to this project.