feat(dgeni): automatically generate API doc links for code span in markdown #2964
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.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Fixes: #2474
What is the new behavior?
Code spans in markdown files that match an API symbols will get automatically wrapped in an anchor pointing to the API doc page.
Does this PR introduce a breaking change?
Other information
There's an important gotcha here. There's not a good way to check if the code span is already wrapped in a link so any code span that links to package guides with a code span will be double wrapped. For that reason, guide links should not use code spans. e.g.
incorrect:
correct: