feat: Allow external tools to insert references that are OK to skip #7
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
E.g. mkdocstrings-crystal can proactively insert links (by writing out the exact HTML that's prescribed here) that in the end can turn out to not be present anywhere, and since those are auto-inserted, they are not actionable for the user, so there should be no warning for them. So mkdocstrings-crystal will switch to `<span data-autorefs-optional="...">`. Also migrate the "required" case to new data- keys, because this is not specific to mkdocstrings now.
pawamoy
approved these changes
Apr 30, 2021
| @@ -10,7 +10,10 @@ | |||
| from markdown.inlinepatterns import REFERENCE_RE, ReferenceInlineProcessor | |||
| from markdown.util import INLINE_PLACEHOLDER_RE | |||
|
|
|||
| AUTO_REF_RE = re.compile(r'<span data-mkdocstrings-identifier=("?)(?P<identifier>[^"<>]*)\1>(?P<title>.*?)</span>') | |||
| AUTO_REF_RE = re.compile( | |||
| r"<span data-(?P<kind>autorefs-identifier|autorefs-optional|mkdocstrings-identifier)=" | |||
There was a problem hiding this comment.
I guess mkdocstrings-identifier is just for backward compatibility?
There was a problem hiding this comment.
Yes. Just implicitly deprecated.
oprypin
added a commit
to oprypin/mkdocstrings
that referenced
this pull request
May 2, 2021
oprypin
added a commit
to oprypin/mkdocstrings
that referenced
this pull request
May 2, 2021
pawamoy
pushed a commit
to mkdocstrings/mkdocstrings
that referenced
this pull request
May 8, 2021
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.
E.g. mkdocstrings-crystal can proactively insert links (by writing out the exact HTML that's prescribed here) that in the end can turn out to not be present anywhere, and since those are auto-inserted, they are not actionable for the user, so there should be no warning for them. So mkdocstrings-crystal will switch to
<span data-autorefs-optional="...">.Also migrate the "required" case to new data- keys, because this is not specific to mkdocstrings now.