Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): Don't inherit @system notices from ancestry #23312

Merged
merged 1 commit into from
Dec 13, 2024
Merged

fix(docs): Don't inherit @system notices from ancestry #23312

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/infra/api-markdown-documenter/render-api-documentation.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ export async function renderApiDocumentation(inputDir, outputDir, uriRootDir, ap
createDefaultLayout: layoutContent,
getAlertsForItem: (apiItem) => {
const alerts = [];
if (ApiItemUtilities.ancestryHasModifierTag(apiItem, "@system")) {
if (ApiItemUtilities.hasModifierTag(apiItem, "@system")) {
alerts.push("System");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about using constants for these tag names?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally, I think the code reads more easily with them as inline literals, especially since they're each only used in one place AFAIK. I don't feel too strongly about this, but I think I will at least consider this beyond the scope of the PR.

} else {
if (ApiItemUtilities.isDeprecated(apiItem)) {
Expand Down
Loading