Skip to content

Conversation

@tigerros
Copy link

Instead of using > Message, we should use <div class="warning">Message</div>. Comparison:

doc-warning-comparison

@marc2332 marc2332 self-requested a review December 17, 2023 18:38
@marc2332 marc2332 added the documentation Improvements or additions to documentation label Dec 17, 2023
@marc2332
Copy link
Owner

isn't there a way to do it with Markdown? the warning thing

@tigerros
Copy link
Author

No, I don't think so. I looked at the commonmark reference and they do have a blockquote, but rustdoc just styles it like that. The div is what rustdoc recommends instead (https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html#adding-a-warning-block).

@codecov
Copy link

codecov bot commented Dec 17, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (e37f663) 52.63% compared to head (86f032b) 52.63%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #431   +/-   ##
=======================================
  Coverage   52.63%   52.63%           
=======================================
  Files         146      146           
  Lines       12808    12808           
=======================================
  Hits         6742     6742           
  Misses       6066     6066           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@marc2332
Copy link
Owner

ah nice 👀

@marc2332 marc2332 merged commit 5add4a8 into marc2332:main Dec 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants