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

Markdownlint: add custom rule to fix double spaces #20824

Merged
merged 2 commits into from
Oct 10, 2022

Conversation

OnkarRuikar
Copy link
Contributor

Improves #17988

Description

Markdownlint doesn't flag/fix double spaces in text content. So we can add the capability to it using a custom rule.

Motivation

Issues like this pile up over time and lead to many drive by typo fix PRs.
Adding this to our custom rules collection will solve it for good.

Additional details

Note: We are not fixing it in code blocks, only in markdown text content.

cc/ @teoli2003, @nschonni

@OnkarRuikar OnkarRuikar requested review from a team as code owners September 17, 2022 07:45
@OnkarRuikar OnkarRuikar requested review from hamishwillee and removed request for a team September 17, 2022 07:45
@github-actions github-actions bot added the Content:MathML MathML docs label Sep 17, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Sep 17, 2022

Preview URLs (7 pages)
Flaws (1)

Note! 6 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/CSS/CSS_Selectors
Title: CSS selectors
Flaw count: 1

  • macros:
    • /en-US/docs/Web/HTML/Element/h2 redirects to /en-US/docs/Web/HTML/Element/Heading_Elements

(this comment was updated 2022-10-10 03:21:09.101635)

@nschonni
Copy link
Contributor

Prettier does this, so -0 on duplicating with a custom rule

@OnkarRuikar
Copy link
Contributor Author

Prettier does this,

But Prettier is not going to get integrated soon. Not even in Q4. We can easily remove this after Prettier is automated.

@OnkarRuikar OnkarRuikar force-pushed the custom_md_rule branch 3 times, most recently from 299a6ef to 6163552 Compare September 26, 2022 01:51
@github-actions github-actions bot removed the Content:MathML MathML docs label Oct 2, 2022
@OnkarRuikar OnkarRuikar requested review from a team as code owners October 10, 2022 03:18
@OnkarRuikar OnkarRuikar requested review from rebloor and estelle and removed request for a team October 10, 2022 03:18
@github-actions github-actions bot added Content:CSS Cascading Style Sheets docs Content:Learn Learning area docs Content:MathML MathML docs Content:Other Any docs not covered by another "Content:" label Content:WebExt WebExtensions docs labels Oct 10, 2022
@OnkarRuikar
Copy link
Contributor Author

These are the new occurrences of the typo committed after the PR was opened.

Copy link
Contributor

@rebloor rebloor left a comment

Choose a reason for hiding this comment

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

Checked the web extension change, looks good. Spot checked some others and they look good too

@estelle estelle merged commit 300849e into mdn:main Oct 10, 2022
@OnkarRuikar OnkarRuikar deleted the custom_md_rule branch October 11, 2022 03:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:CSS Cascading Style Sheets docs Content:Learn Learning area docs Content:MathML MathML docs Content:Other Any docs not covered by another "Content:" label Content:WebExt WebExtensions docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants