-
Notifications
You must be signed in to change notification settings - Fork 535
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.
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
Conversation
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output
|
@system
notices from ancestry@system
notices from ancestry
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copilot reviewed 1 out of 1 changed files in this pull request and generated no suggestions.
Comments skipped due to low confidence (1)
docs/infra/api-markdown-documenter/render-api-documentation.mjs:95
- The change from
ancestryHasModifierTag
tohasModifierTag
may cause the function to miss@system
tags inherited from parent items. Ensure this change aligns with the intended behavior of not inheriting@system
notices from ancestry.
if (ApiItemUtilities.hasModifierTag(apiItem, "@system")) {
Tip: If you use Visual Studio Code, you can request a review from Copilot before you push from the "Source Control" tab. Learn more
@@ -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"); |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
It is valid for a non-
@system
API to extend a@system
one. See here for more details on our tags, including@system
. In fact, this is a common pattern - we introduce a base interface that some of our API members extend. We don't want customers to use that base interface directly, but it needs to exist for one reason or another. In this case, we don't want the implementations of that interface to inherit the@system
notice.AB#22762