No Punctuation at End of Headings

This rule checks for headings that end with either a period (.) or a colon (:). In technical documentation, headings should be clean and concise without unnecessary terminal punctuation. Ending headings with punctuation marks like periods or colons can make the document structure less clean and is generally considered poor style in technical writing.

Examples:

Will flag:

## Introduction to Programming.
# Getting Started:
### Database Setup.

Will not flag:

## Introduction to Programming
# Getting Started
### Database Setup
## How vs. Why (periods within the heading are fine)
## Working with MySQL: A Guide (only checks for colons at the end)

The rule helps maintain consistent heading formatting throughout your documentation and adheres to common technical writing best practices.

Rule Source

This rule comes from: https://github.com/mesosphere/dcos-docs-site

Rule Definition

---
extends: existence
message: Do not use '%s' at the end of headings
link: https://github.com/cockroachdb/docs/blob/master/STYLE.md#capitalization-and-punctuation
scope: heading
level: warning
raw:
  - '(?:\:|\.)$'