| Commit message (Collapse) | Author | Age |
|
|
|
| |
profile.template and sort.py have been released for a while now.
|
|
|
|
|
|
|
| |
And the surrounding paragraphs.
Attempt 2; see commit be5e5f5cd ("pull_request_template.md: restore
indentation", 2023-02-25).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Ensure consistent line breaks around headings, lists and code blocks.
To make them more readable and also more portable (which could help when
previewing/converting files locally).
From the CommonMark Spec (version 0.30, published on 2021-06-19)[1]:
> 1.2 Why is a spec needed?
[...]
> 2. Is a blank line needed before a block quote or heading? Most
> implementations do not require the blank line. However, this can
> lead to unexpected results in hard-wrapped text, and also to
> ambiguities in parsing (note that some implementations put the
> heading inside the blockquote, while others do not). (John Gruber
> has also spoken in favor of requiring the blank lines.)[2]
>
> 3. Is a blank line needed before an indented code block?
> (`Markdown.pl` requires it, but this is not mentioned in the
> documentation, and some implementations do not require it.)
Fixes[3]:
* MD022 Headers should be surrounded by blank lines
* MD031 Fenced code blocks should be surrounded by blank lines
* MD032 Lists should be surrounded by blank lines
Environment: ruby-mdl 0.12.0-1 on Artix Linux.
[1] https://spec.commonmark.org/0.30/#why-is-a-spec-needed-
[2] http://article.gmane.org/gmane.text.markdown.general/2146
[3] https://github.com/markdownlint/markdownlint/blob/main/docs/RULES.md
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
This partially reverts commit 375468008 ("docs: remove indents on
top-level lists and tables", 2023-02-01) from PR #5674.
Commands used to undo the changes:
$ f=.github/pull_request_template.md; \
git show 3754680087~1:"$f" >"$f"
I had assumed that a blank line after a list item would end the list
(and so I was confused by the amount of indentation used), but that is
apparently not the case. See the file rendered before/after the
commit[1] [2].
Relates to #2784.
Reported by @rusty-snake[3].
[1] https://github.com/netblue30/firejail/blob/f5d8d8cc7af8f8816c47623515babcefceb7e22f/.github/pull_request_template.md
[2] https://github.com/netblue30/firejail/blob/37546800876d977d77cc86d9b307f8cfa714c1dd/.github/pull_request_template.md
[3] https://github.com/netblue30/firejail/pull/5674#discussion_r1117892922
|
|
|
|
|
|
| |
And the surrounding paragraphs.
Relates to #2784.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Commands used to search and replace:
$ git grep -Ilz '[[:blank:]]$' |
xargs -0 -I '{}' sh -c "printf '%s\n' \"\$(sed -E \
's/[[:blank:]]+$//' '{}')\" >'{}'"
This fixes all of the "trailing whitespace" errors raised by git:
$ git diff --check 4b825dc642cb6eb9a060e54bf8d69288fbee4904..HEAD |
grep '^[^+]' | cut -f 3 -d : | LC_ALL=C sort | uniq -c
72 space before tab in indent.
4 trailing whitespace.
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
* add contrib/sort.py and .github/pull_request_temp…
* Add usage to sort.py
* Install sort.py if contrib-install is set
* sort.py: 0644 -> 0755
* Update sort.py
* Update pull_request_template.md
* Remove checkboxes from PR-Template
* Update sort.py
* Add examples to sort.py
* Update pull_request_template.md
Fix path to sort.py, it depend on the distro.
* Update pull_request_template.md
* Update pull_request_template.md
add hint about template
|