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

Pmolloy/mdl all the things #93

Merged
merged 19 commits into from
Oct 25, 2024
Merged

Pmolloy/mdl all the things #93

merged 19 commits into from
Oct 25, 2024

Conversation

pamolloy
Copy link
Contributor

No description provided.

@pamolloy pamolloy requested a review from orangecms October 18, 2024 12:20
- MD004 Unordered list style
- MD005 Inconsistent indentation for list items at the same level
- MD013 Line length
- MD025 Multiple top level headers in the same document
- MD030 Spaces after list markers

Signed-off-by: Philip Molloy <[email protected]>
@pamolloy pamolloy force-pushed the pmolloy/mdl-all-the-things branch from c084b60 to b1bbbd2 Compare October 18, 2024 12:23
The line length was inconsistent in the two parts of the file. The
footnotes will addressed in another commit.

Also correct multiple blank lines on line 26.

Signed-off-by: Philip Molloy <[email protected]>
@pamolloy pamolloy force-pushed the pmolloy/mdl-all-the-things branch from b1bbbd2 to 716c505 Compare October 18, 2024 12:25
- MD013 Line length
- MD022 Headers should be surrounded by blank lines

Signed-off-by: Philip Molloy <[email protected]>
Signed-off-by: Philip Molloy <[email protected]>
- MD013 Line length
- MD022 Headers should be surrounded by blank lines
- MD032 Lists should be surrounded by blank lines
- MD034 Bare URL used
- Minor spelling mistake

Signed-off-by: Philip Molloy <[email protected]>
- MD013 Line length
- MD014 Dollar signs used before commands without showing output
- MD031 Fenced code blocks should be surrounded by blank lines

Signed-off-by: Philip Molloy <[email protected]>
- MD013 Line length
- MD014 Dollar signs used before commands without showing output
- MD026 Trailing punctuation in header
- MD029 Ordered list item prefix
- MD034 Bare URL used
- MD036 Emphasis used instead of a header
- MD046 Code block style
- Fix small spelling mistake
- Add syntax highlighting to go code blocks

Signed-off-by: Philip Molloy <[email protected]>
@pamolloy
Copy link
Contributor Author

Ok, I didn't fix "all the things", but a good effort for now. 😅

@pamolloy pamolloy marked this pull request as ready for review October 18, 2024 13:56
Signed-off-by: Philip Molloy <[email protected]>
- "counter-intuitive" is more readable than "counterintuitive"
- Use in-line code styling
- Remove unnecessary HTML comment
- Footnotes do not need a section header since they are at the end of
  the document

Signed-off-by: Philip Molloy <[email protected]>
- MD001 Header levels should only increment by one level at a time
- MD002 First header should be a top level header
- MD025 Multiple top level headers in the same document
- MD032 Lists should be surrounded by blank lines

Signed-off-by: Philip Molloy <[email protected]>
@pamolloy
Copy link
Contributor Author

This PR removes 337 out of 539 mdl warnings

$ go run github.com/linuxboot/corebootnerf --fetch
... lots and lots of output!
```
$ go get github.com/linuxboot/corebootnerf
Copy link
Collaborator

Choose a reason for hiding this comment

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

just spotting this here (not PR related), we gotta rework such things since Go changed in terms of get/install semantics

@orangecms orangecms merged commit bf7e911 into main Oct 25, 2024
3 checks passed
@orangecms orangecms deleted the pmolloy/mdl-all-the-things branch October 25, 2024 15:21
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