Skip to content

Add rule for consistent punctuation in lists #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rtrieu wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add rule for consistent punctuation in lists #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d125b9b
Create listpunctuation.yml
rtrieu Sep 17, 2025
61f3bab
update rule
rtrieu Sep 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .vale.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,5 @@ Datadog.spaces = YES
Datadog.tense = YES
Datadog.words = YES
Datadog.quotes = YES
Datadog.aws = YES
Datadog.aws = YES
Datadog.listpunctuation = YES
11 changes: 11 additions & 0 deletions styles/Datadog/listpunctuation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
extends: existence
message: "List items should have consistent punctuation."
link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#lists"
level: warning
scope: raw
ignorecase: true
tokens:
# Match bulleted list items starting with -
- '^\s*-\s+.*$'
# Match numbered list items
- '^\s*\d+\.\s+.*$'