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 linting: low hanging fruit #6843

Merged
merged 17 commits into from Jan 23, 2024

Conversation

SeanKilleen
Copy link
Contributor

@SeanKilleen SeanKilleen commented Jan 22, 2024

Summary of the changes (Less than 80 chars)

This gets some of the easiest items out of the way, to clear the room for the others.

Resolves:

  • MD009 (trailing whitespace)
  • MD012 (multiple line blanks)
  • MD018 (extra spaces in heading)
  • MD022 (blank lines around headings)
  • MD031 (blanks around code fences)
  • MD032 (blanks around lists)
  • MD034 (bare URLs)

Supports #5460.

@github-actions github-actions bot added 📚 documentation This issue is about working on our documentation. 🧰 maintenance labels Jan 22, 2024
@SeanKilleen SeanKilleen changed the title WIP: Markdown-linting: low hanging fruit Markdown linting: low hanging fruit Jan 22, 2024
Copy link

codecov bot commented Jan 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (01daf1e) 69.52% compared to head (f80c606) 73.04%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6843      +/-   ##
==========================================
+ Coverage   69.52%   73.04%   +3.52%     
==========================================
  Files        2481     2485       +4     
  Lines      125456   125526      +70     
==========================================
+ Hits        87219    91691    +4472     
+ Misses      38237    33835    -4402     
Flag Coverage Δ
unittests 73.04% <ø> (+3.52%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@SeanKilleen
Copy link
Contributor Author

@michaelstaib this workflow is ready for approval.

@glen-84 feel free to review. You may want to go commit by commit as I address each rule in a commit. I kept this one simple, addressing mostly items around whitespace. I've incorporated the changes from the previously merged PR that adds the markdown lint support.

Copy link
Member

@michaelstaib michaelstaib left a comment

Choose a reason for hiding this comment

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

See @glen-84 comments

@SeanKilleen
Copy link
Contributor Author

@glen-84 @michaelstaib fixed.

@michaelstaib michaelstaib merged commit e8c8d72 into ChilliCream:main Jan 23, 2024
89 of 97 checks passed
@michaelstaib
Copy link
Member

Thank you @SeanKilleen and @glen-84

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 documentation This issue is about working on our documentation. 🌶️ website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants