Skip to content
This repository has been archived by the owner on Nov 19, 2024. It is now read-only.

Markdown linting: Fixed MD046 errors #6646

Merged
merged 23 commits into from
Feb 13, 2020
Merged

Markdown linting: Fixed MD046 errors #6646

merged 23 commits into from
Feb 13, 2020

Conversation

jeff-matthews
Copy link
Contributor

@jeff-matthews jeff-matthews commented Feb 13, 2020

Purpose of this pull request

This pull request (PR) fixes all "fixable" MD046 errors in the devdocs project.

There are still MD046 errors that we cannot fix. The mdl tool identifies code blocks inside nested lists as errors. For example:

1. Lorem ipsum

   - Lorem ipsum

      ```bash
      mkdir
      ```

We can fix these "errors" by removing the line between the bullet and the code block, but that makes the source less readable. Since our goal with enabling linting rules is to promote the readability of source markdown, that's not a viable option.

For now, we should merge the fixes for legitimate errors and report this issue to the mdl maintainers. Until it's fixed however, we won't be enabling this rule on production.

@jeff-matthews jeff-matthews changed the title 5253 integration Markdown linting: Fixed MD046 errors Feb 13, 2020
@dobooth
Copy link
Contributor

dobooth commented Feb 13, 2020

The irony...

@jeff-matthews jeff-matthews added the Editorial Typo and grammar fixes or minor rewrites to correct inaccuracies label Feb 13, 2020
jeff-matthews and others added 2 commits February 13, 2020 10:50
Co-Authored-By: Dmitry Shevtsov <12731225+dshevtsov@users.noreply.github.com>
@jeff-matthews jeff-matthews linked an issue Feb 13, 2020 that may be closed by this pull request
@jeff-matthews
Copy link
Contributor Author

running tests

@jeff-matthews jeff-matthews merged commit 3bdfdc1 into master Feb 13, 2020
@ghost
Copy link

ghost commented Feb 13, 2020

Hi @jeff-matthews, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

@jeff-matthews jeff-matthews deleted the 5253-integration branch February 13, 2020 18:21
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Editorial Typo and grammar fixes or minor rewrites to correct inaccuracies
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Markdown linting: Code block style (MD046)
3 participants