PHPCSStandards / PHP_CodeSniffer

PHP_CodeSniffer tokenizes PHP files and detects violations of a defined set of coding standards.
BSD 3-Clause "New" or "Revised" License
880 stars 54 forks source link

Docs: clean up markdown files #449

Closed jrfnl closed 5 months ago

jrfnl commented 5 months ago

Description

QA/Markdown CS: use consistent header styles

QA/Markdown CS: use consistent list styles

QA/Markdown CS: no consecutive block quotes

Rationale: Some Markdown parsers will treat two blockquotes separated by one or more blank lines as the same blockquote, while others will treat them as separate blockquotes.

QA/Markdown CS: code block consistency

QA/Markdown CS: consistent surrounding pipes for tables

Generally speaking, the "full" table format should always be used - with leading and trailing pipes, but that is a bit awkward for this particular table as a template file like this will typically be edited in a fixed size font, while GH, when using the template to create an issue will use a variable size font.

So, this is a bit of a mix-and-match to, yes, use the full table format, but also make it look reasonable when people edit the table in a new issue.

QA/Markdown CS: various tweaks

Note: especially in the CHANGELOG file, there is a lot more text which should be wrapped in backticks, but that's outside the scope of this current PR, which is aimed at one the one hand preventing markdown parsing problems and on the other hand allowing to run an automated Markdownlint check via CI.

QA/Markdown: fix broken link

QA/Markdown: no duplicate links

Suggested changelog entry

N/A

Related issues/external references

Loosely related to #244