[api-extractor] Rename "API Review File" to "API Report File" #1213
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
…eferring to this file as the "API Report" everywhere
iclanton
approved these changes
Apr 8, 2019
This was referenced Nov 4, 2022
This was referenced Dec 25, 2022
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.
As of AE7 we're now referring to the .api.md file everywhere as an "API Report File" (whereas API Extractor 6 called it an "API Review File"). This PR fixes a bunch of inconsistent places, most notably the
"addToApiReviewFile"setting in the api-extractor.json config file schema. (This is breaking change, but a somewhat rarely used setting.)We still use the "API review" terminology for the actual review process. For example, the message still says "Please request an API review", and Rush's common/reviews folder name will still be standard. But the main point is that the .api.md file is often used instead for other workflows that are not formal API "reviews".