feat: Provide hook interface, use it to expand identifiers and attach additional context to references #46
Conversation
This file contains 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
… additional context to references
pawamoy
commented
May 14, 2024
… attach additional context to references
This was referenced Aug 23, 2024
… attach additional context to references
pawamoy
added a commit
to mkdocstrings/mkdocstrings
that referenced
this pull request
Sep 1, 2024
Based-on-PR-autorefs#46: mkdocstrings/autorefs#46
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This will allow a few things (some immediately, and some later):
.-prefixed reference identifiers (relative identifiers) #37)immediately (with a bit more thinking & work): allow customizing anchors while retaining full autorefs ability (see Trim anchors crystal#8)actually not relevantThis PR is the foundation for a follow-up PR in mkdocstrings: mkdocstrings/mkdocstrings#666. The changes over there actually allow handlers to hook into autorefs, while this PR here only provides the contract/interface.
This private PR shows an example hook implementation in mkdocstrings-python Insiders to support relative cross-refs using objects' scope to resolve them.