[api-extractor] Add an experimental new ApiItem.canonicalReference property - #1406
Merged
Pete Gonzalez (octogonz) merged 25 commits intoAug 8, 2019
Merged
Conversation
…overloadIndex of 0 instead of 1
Co-Authored-By: Ron Buckton <ron.buckton@microsoft.com>
…-new-canonical-references
Pete Gonzalez (octogonz)
force-pushed
the
octogonz/ae-new-canonical-references
branch
from
July 23, 2019 00:23
96f1e6b to
6da8406
Compare
Pete Gonzalez (octogonz)
force-pushed
the
octogonz/ae-new-canonical-references
branch
from
July 23, 2019 01:59
9a9d3e5 to
dec3e00
Compare
…clarationReference.parseComponent()
…-new-canonical-references
Pete Gonzalez (octogonz)
requested a review
from Pat Miller (patmill)
as a code owner
July 24, 2019 00:45
…-new-canonical-references # Conflicts: # common/config/rush/pnpm-lock.yaml
…larify that it is not intended to be a general purpose property setter
…ntryPoint will participate in the `ApiItem.canonicalReference` in the future
Vitalie Braga (Vitalius1)
approved these changes
Aug 8, 2019
Pete Gonzalez (octogonz)
deleted the
octogonz/ae-new-canonical-references
branch
August 8, 2019 00:34
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
3 participants
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.
As part of the work to support hyperlinks for types that appear in the documentation (PR #1337), we need to introduce a new API for building canonical references with the new notation that Ron Buckton (@rbuckton) prototyped in microsoft/tsdoc#172.
This is PR sets up the
ApiItem.canonicalReferencefor this purpose. It is marked as@beta, but the values are written in the .api.json file format for informational purposes.