-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Document suppress in supportedAstroFeatures
#11825
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
Conversation
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
Co-authored-by: Matt Kane <[email protected]>
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.
Thank you Yan! See what you think about my idea for structuring this below, plus some questions about trying to get the code samples to help demonstrate the purpose behind setting them!
| } | ||
| ``` | ||
| If the default log message sent along with your custom message can cause confusion, you can use `suppress: "default"` to suppress the default message: |
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.
I'm thinking of a structure like this (tell me what you think)
Up around line 375 at the beginning of this section, we have:
When using these properties, Astro will:
- run specific validation;
- emit contextual to the logs;
(Aside: should that be "emit contextual INFORMATION to the logs" ??)
These operations are run based on the features supported or not supported, their level of support, the desired amount of logging, and the user's own configuration.
Then here, we can actually have a proper heading for this option:
| If the default log message sent along with your custom message can cause confusion, you can use `suppress: "default"` to suppress the default message: | |
| ### `suppress` | |
| <p> | |
| **Type:** `default | all`<br /> | |
| <Since v="5.9.0" /> | |
| </p> | |
| An option to prevent showing some or all logged messages. | |
| If Astro's default log message is confusing to the user in combination with your custom `message`, you can use `suppress: "default"` to suppress the default message and only log your message: |
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.
(Aside: should that be "emit contextual INFORMATION to the logs" ??)
probably, yeah. We found a typo!
|
Sorry, my previous commit merged before I changed the commit message! Previous commit:
|
… and an example of when
Description (required)
This adds documentation for
suppress: "all"andsuppress: "default"in thesupportedAstroFeaturesproperty ofsetAdapter().Related issues & labels (optional)