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

Use fancy md notes #503

Merged
merged 3 commits into from
Jul 15, 2024
Merged

Use fancy md notes #503

merged 3 commits into from
Jul 15, 2024

Conversation

rviscomi
Copy link
Member

@rviscomi rviscomi commented Jul 15, 2024

This makes use of GitHub's fancy note/warning UI in markdown, which helps them stand out. Use the rich diff to see the effects.

Also converted a few places that talk about FID deprecation to use a more noticeable "Caution" UI.

Copy link
Member

@philipwalton philipwalton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! These changes LGTM.

It looks like the linter process is failing now, though, so can you look into whether that was due to these changes and if so figure out how to fix?

@rviscomi
Copy link
Member Author

Looks like it was caused by a multi-line note. Prettier fixed it by adding the blockquote syntax, although we could have also just made it a single-line note. Went with the prettier fix and the linter seems to be happy now.

README.md Outdated Show resolved Hide resolved
@philipwalton
Copy link
Member

Looks like it was caused by a multi-line note. Prettier fixed it by adding the blockquote syntax, although we could have also just made it a single-line note. Went with the prettier fix and the linter seems to be happy now.

Ahh, just saw this comment, my preference would be to make it a single line so it's consistent with the other notes.

@philipwalton philipwalton merged commit 9bce28a into main Jul 15, 2024
8 checks passed
@philipwalton philipwalton deleted the rviscomi-patch-1 branch July 15, 2024 19:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants