-
Notifications
You must be signed in to change notification settings - Fork 13.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
Fundamentals Part 1: Update list items to layout styling guide #27141
Fundamentals Part 1: Update list items to layout styling guide #27141
Conversation
As per style guide, changed all asterisks to hyphens for all unordered list items This is so the markdown is consistent, even though either would render the same
As per style guide, lazy numbering is preferred and is consistent with all other markdown documents.
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 making the update and also resolving some of the lint errors! Would you want to resolve some of the remaining ones (blanks lines around headings, using asterisk syntax for strong/emphasis instead of underline)?
Also can you just update your comment from Closes [issue number]
to Related to [issue number]
, we don't want this PR automatically closing the issue since it's tied to several lessons.
Thanks, I was confused at the markdown lint. But now I understand what it is! I have made all the changes and changed to |
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.
Understandable! It's a new addition to the repo to help automate the process of finding these issues (rather than having to manually sift through lessons and find what needs to be updated). Thanks again for making these updates!
Because
There are many lessons that have inconsistent styling techniques. By correcting the list items to a unified method, this makes all markdown documents consistent, easier to read, and edit in the future.
This PR
Issue
Related to #27119
Additional Information
Pull Request Requirements
location of change: brief description of change
format, e.g.Intro to HTML and CSS lesson: Fix link text
Because
section summarizes the reason for this PRThis PR
section has a bullet point list describing the changes in this PRIssue
section