Andreas/markdownlint
1
0
Fork 0
mirror of https://github.com/DavidAnson/markdownlint.git synced 2026-02-16 02:08:06 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Added md046 sentences-per-line

Browse source
This commit is contained in:
Josh Goldberg 2018-06-22 09:23:39 -07:00
parent 2710c375b3
commit 56643d90db
6 changed files with 140 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

15
doc/Rules.md
View file

@ -1461,3 +1461,18 @@ Or with reference syntax as:
Guidance for writing alternate text is available from the [W3C](https://www.w3.org/WAI/alt/),
[Wikipedia](https://en.wikipedia.org/wiki/Alt_attribute), and
[other locations](https://www.phase2technology.com/blog/no-more-excuses-definitive-guide-alt-text-field).
<a name="md046"></a>
## MD046 - Sentences Per Line
Tags: line_length, spacing
A lot of markdown commits are small corrections such as spelling or grammar fixes.
Having multiple sentences in a line increases the git commit diff size for these
smaller fixes.
It's good to follow all sentence-ending periods with an endline to reduce the chance
of conflicts.
For documentation that tends towards long sentences, this can be a good alternative
to strict line lengths.