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.

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

[Markdown] [Web/API] Make notes and warnings consistently formatted #8180

Closed
wbamberg opened this issue Aug 21, 2021 · 1 comment
Closed
Labels
needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened.

Comments

@wbamberg
Copy link
Collaborator

wbamberg commented Aug 21, 2021

This is part of #7898 .

The Markdown converter is a bit picky about what it considers to be valid notes and warnings.

Specifically, it expects to see:

  • a <div> with class="note" or class="warning"
  • whose first child is a <p>
  • whose first child is <strong>Note:</strong> or <strong>Warning:</strong>

...e.g.

<div class="note">
  <p><strong>Note:</strong> ... </p>
</div>

or

<div class="warning">
  <p><strong>Warning:</strong> ... </p>
</div>

In Web/API, many notes and warnings don't follow this pattern (I counted about 800 notes, and I didn't count warnings yet, but probably not as many). These will need to be fixed.

Luckily there are a few common patterns we can automate (in particular <p><strong>Note</strong>:), and then there will be some leftovers we have to do manually.

@wbamberg
Copy link
Collaborator Author

#8244 completes this work :).

@wbamberg wbamberg mentioned this issue Aug 28, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 24, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
needs triage Triage needed by staff and/or partners. Automatically applied when an issue is opened.
Projects
None yet
Development

No branches or pull requests

1 participant