-
Notifications
You must be signed in to change notification settings - Fork 629
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
docs(archive,assert,cache,cli,encoding,html,http,net,streams,text): remove unstable Markdown alert #5672
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5672 +/- ##
==========================================
- Coverage 96.22% 96.21% -0.01%
==========================================
Files 481 481
Lines 38751 38751
Branches 5618 5618
==========================================
- Hits 37289 37286 -3
- Misses 1420 1423 +3
Partials 42 42 ☔ View full report in Codecov by Sentry. |
This doesn't seem aligned with CLI's policy. |
I agree with removing the |
It's true that that the CLI uses the unstable note. But I still think it's not needed. Hints in the IDE show the |
Furthermore, while the CLI employs this convention, it's not in the Deno Style Guide. I think these reasons provide sufficient justification to deviate. |
I disagree with this. JSR rendering of The Spinner docs in IDE after this change. It's at the last line, and it doesn't seem enough alerting. It's likely the users miss this. |
That's because We can do:
WDYT? |
That looks better to me, but I think it's still important for CLI and STD to have the same policy (formatting) for this to make things less confusing. @bartlomieju What do you think about the above suggested formatting? |
This now looks a good compromise between consistency with CLI and better rendering in IDE and JSR. Let's do this |
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.
LGTM
No description provided.