docs(docs-infra): add support for @example
#60443
Closed
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
alan-agius4
added
action: review
angular-robot
bot
added
area: docs
In TSDoc, we currently handle the `@usageNotes` annotation, but this is not a standard TSDoc tag. Instead, the `@example` annotation is the correct standard, which is used in the Angular CLI repo and on the SSR package. This change ensures that `@example` is treated the same as `@usageNotes` during the transform process and also handle multiple instances of `@example` on the same tag.
alan-agius4
force-pushed
the
usage-notes-adev
branch
from
b181654 to
53c0321
Compare
alan-agius4
added
action: merge
|
Deployed adev-preview for 53c0321 to: https://ng-dev-previews-fw--pr-angular-angular-60443-adev-prev-rxhvj2g1.web.app Note: As new commits are pushed to this pull request, this link is updated after the preview is rebuilt. |
|
This PR was merged into the repository by commit 8e48bc9. The changes were merged into the following branches: main, 19.2.x |
pkozlowski-opensource
pushed a commit
that referenced
this pull request
Mar 18, 2025
In TSDoc, we currently handle the `@usageNotes` annotation, but this is not a standard TSDoc tag. Instead, the `@example` annotation is the correct standard, which is used in the Angular CLI repo and on the SSR package. This change ensures that `@example` is treated the same as `@usageNotes` during the transform process and also handle multiple instances of `@example` on the same tag. PR Close #60443
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.
In TSDoc, we currently handle the
@usageNotesannotation, but this is not a standard TSDoc tag. Instead, the@exampleannotation is the correct standard, which is used in the Angular CLI repo and on the SSR package.This change ensures that
@exampleis treated the same as@usageNotesduring the transform process and also handle multiple instances of@exampleon the same tag.Example
