docs(docs-infra): add support for @remarks
#58523
Closed
Conversation
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
In TSDoc, we currently handle the `@usageNotes` annotation, but this is not a standard TSDoc tag. Instead, the `@remarks` annotation is the correct standard, which is used in the Angular CLI repo and on the SSR package. This change ensures that `@remarks` is treated the same as `@usageNotes` during the transform process.
thePunderWoman
pushed a commit
that referenced
this pull request
Nov 7, 2024
In TSDoc, we currently handle the `@usageNotes` annotation, but this is not a standard TSDoc tag. Instead, the `@remarks` annotation is the correct standard, which is used in the Angular CLI repo and on the SSR package. This change ensures that `@remarks` is treated the same as `@usageNotes` during the transform process. PR Close #58523
thePunderWoman
pushed a commit
that referenced
this pull request
Nov 7, 2024
In TSDoc, we currently handle the `@usageNotes` annotation, but this is not a standard TSDoc tag. Instead, the `@remarks` annotation is the correct standard, which is used in the Angular CLI repo and on the SSR package. This change ensures that `@remarks` is treated the same as `@usageNotes` during the transform process. PR Close #58523
Contributor
|
This PR was merged into the repository by commit c5ce302. The changes were merged into the following branches: main, 18.2.x, 19.0.x |
josephperrott
added a commit
to josephperrott/angular
that referenced
this pull request
Nov 7, 2024
This reverts commit c5ce302.
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
In TSDoc, we currently handle the
@usageNotesannotation, but this is not a standard TSDoc tag. Instead, the@remarksannotation is the correct standard, which is used in the Angular CLI repo and on the SSR package.This change ensures that
@remarksis treated the same as@usageNotesduring the transform process.