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

Enable linting rule MD032 (blank lines around lists) #5415

Merged
merged 33 commits into from
Sep 18, 2019

Conversation

jeff-matthews
Copy link
Contributor

@jeff-matthews jeff-matthews commented Sep 18, 2019

Purpose of this pull request

This pull request (PR) enables rule MD032, which requires blank lines around lists.

Related to #5250

Additional info

This PR fixes a majority of issues, but there are still 38 errors:

rake test:md
Testing Markdown style with mdl ...
guides/v2.2/cloud/cdn/trouble-fastly.md:208: MD032 Lists should be surrounded by blank lines
guides/v2.2/cloud/cdn/trouble-fastly.md:237: MD032 Lists should be surrounded by blank lines
guides/v2.2/mrg/ce/Signifyd.md:48: MD032 Lists should be surrounded by blank lines
guides/v2.3/cloud/cdn/trouble-fastly.md:208: MD032 Lists should be surrounded by blank lines
guides/v2.3/cloud/cdn/trouble-fastly.md:237: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/b2b/CompanyCredit.md:15: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/Analytics.md:38: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/Catalog.md:8: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/CatalogWidget.md:10: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/Deploy.md:16: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/Deploy.md:17: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/Indexer.md:10: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/InstantPurchase.md:12: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/Paypal.md:8: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/Reports.md:8: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/Robots.md:8: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/Sales.md:12: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/Sales.md:15: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/SalesSequence.md:12: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/SalesSequence.md:15: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/SampleData.md:30: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/SampleData.md:64: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/Security.md:11: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/Signifyd.md:50: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/Tax.md:12: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/Tax.md:13: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/Tax.md:17: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/Tax.md:22: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/Tax.md:24: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/Weee.md:25: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ce/Weee.md:32: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ee/CatalogPermissions.md:9: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ee/CatalogPermissions.md:12: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ee/Staging.md:13: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ee/Staging.md:19: MD032 Lists should be surrounded by blank lines
guides/v2.3/mrg/ee/Staging.md:31: MD032 Lists should be surrounded by blank lines

A detailed description of the rules is available at https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md

The Markdown linter has found 38 issues

The cloud errors are interesting because the reported issue is inside a fenced code block and is considered a false positive because it's intended to be terminal output.

The MRG errors must be fixed in the source READMEs; not in devdocs.

I propose reverting the change in this PR that enables the rule, but merging all the other fixes while we fix the MRG READMEs and address the outstanding cloud issue.

@jeff-matthews jeff-matthews requested review from dshevtsov, hguthrie and a team September 18, 2019 15:50
@jeff-matthews jeff-matthews self-assigned this Sep 18, 2019
@jeff-matthews jeff-matthews added the Site Improvements Updates to tools, processes, and site architecture that improve reader and contributor experience label Sep 18, 2019
@jeff-matthews
Copy link
Contributor Author

I turned off the rule. We can merge this PR pending approval.

Copy link
Contributor

@hguthrie hguthrie left a comment

Choose a reason for hiding this comment

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

I added one note about a section that was deleted. I agree with the deletion, but there is an open bug ticket on that very section. I wasn't sure how to handle it, which it why I created the bug.

@jeff-matthews
Copy link
Contributor Author

running tests

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Site Improvements Updates to tools, processes, and site architecture that improve reader and contributor experience
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants