-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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
Include note of common profiling issue #9484
Conversation
Example |
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.
This is a nice improvement! Both the common issue and the cleanup are nice.
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.
Thanks for writing this! Some minor wording changes and then we're good to go.
Co-authored-by: JMS55 <[email protected]>
Co-authored-by: JMS55 <[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.
You need to increase all your heading levels by 1, there can be only one #
-level heading.
The linter is also unhappy about your note: https://github.com/updownpress/markdown-lint/blob/master/rules/036-no-emphasis-as-header.md
it seems it's the first time the linter passed on this file, and it's unhappy with the list made with |
I was following the patterns in https://raw.githubusercontent.com/bevyengine/bevy/v0.11.2/examples/README.md. Will update them in the morning, didn't know about the markdown linter, thanks! |
Rendered.
Suggested by Jasmine on discord.