This repository has been archived by the owner on Nov 19, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixing MD046 errors part 1
Fixing MD046 errors part 2
Fixing MD046 errors part 3
Fixing MD046 errors part 4
Co-Authored-By: Margaret Eker <meker@adobe.com>
Fixing MD046 errors part 5
The irony... |
jeff-matthews
added
the
Editorial
Typo and grammar fixes or minor rewrites to correct inaccuracies
label
Feb 13, 2020
dshevtsov
reviewed
Feb 13, 2020
Co-Authored-By: Dmitry Shevtsov <12731225+dshevtsov@users.noreply.github.com>
dshevtsov
approved these changes
Feb 13, 2020
running tests |
Hi @jeff-matthews, thank you for your contribution! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
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.