Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 19 Apr 2023 18:42:01 GMT
From:      Muhammad Moinur Rahman <bofh@FreeBSD.org>
To:        doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org
Subject:   git: 582467b11d - main - vale/styles: Update version =>dd Semantic Line Break checking with vale
Message-ID:  <202304191842.33JIg16h016225@gitrepo.freebsd.org>

next in thread | raw e-mail | index | archive | help
The branch main has been updated by bofh:

URL: https://cgit.FreeBSD.org/doc/commit/?id=582467b11d484e71fd4d621fbf29de666ac3ce6b

commit 582467b11d484e71fd4d621fbf29de666ac3ce6b
Author:     Muhammad Moinur Rahman <bofh@FreeBSD.org>
AuthorDate: 2023-04-19 18:35:37 +0000
Commit:     Muhammad Moinur Rahman <bofh@FreeBSD.org>
CommitDate: 2023-04-19 18:41:53 +0000

    vale/styles: Update version =>dd Semantic Line Break checking with vale
    
    In our doc guidelines we use "One Sentence Per Line" or more technically
    Semantic Line Breaking. Use vale to implement this. This patch also
    handles some exceptions with Inc. and e.g. which will contain . but not
    apparently at the end of line.
    
    Approved by:    carlavilla (mentor)
    Differential Revision:  https://reviews.freebsd.org/D39560
---
 .vale/styles/FreeBSD/SemanticLineBreak.yml | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/.vale/styles/FreeBSD/SemanticLineBreak.yml b/.vale/styles/FreeBSD/SemanticLineBreak.yml
new file mode 100644
index 0000000000..3c685c970c
--- /dev/null
+++ b/.vale/styles/FreeBSD/SemanticLineBreak.yml
@@ -0,0 +1,8 @@
+extends: occurrence
+message: "Only use one sentence per line."
+level: suggestion
+scope:
+  - paragraph
+  - list
+max: 1
+token: '(?<!Inc|e\.g)[.!?](?: |$)'



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202304191842.33JIg16h016225>