Search

# Warning: gitlab.BadPlurals

#

# Don't write plural words with the '(s)' construction. "HTTP(S)" is acceptable.

# Warning: gitlab.SentenceLength

#

# Counts words in a sentence and alerts if a sentence exceeds 25 words.

# Warning: gitlab.EOLWhitespace

#

# Checks that there is no useless whitespace at the end of lines.

# Warning: gitlab.InclusionCultural

#

# Suggests alternatives for words that are culturally inappropriate.

# Warning: gitlab.DefaultBranch

#

# Do not refer to the default branch as the "master" branch, if possible.

# Warning: gitlab.MeaningfulLinkWords

#

# Checks for the presence of semantically unhelpful words in link text.

# Warning: gitlab.LatinTerms

#

# Checks for use of Latin terms.

# Warning: gitlab.FirstPerson

#

# Checks for use of first person pronouns.

# Warning: gitlab.NonStandardQuotes

#

# Use only standard single and double quotes, not left or right quotes.

# Warning: gitlab.HeadingDepth

#

# Checks that there are no headings greater than 3 levels

# Warning: gitlab.HeadingContent

#

# Checks for generic, unhelpful subheadings.

# Warning: gitlab.Markdown_emoji

#

# Check for use of GLFM emoji syntax (https://docs.gitlab.com/ee/user/markdown.html#emojis), which doesn't render correctly in documentation.

# Warning: gitlab.FutureTense

#

# Checks for use of future tense in sentences. Present tense is strongly preferred.

# Warning: gitlab.ToDo

#

# You should not use "To Do", unless it refers to the UI element.

# Warning: gitlab.OxfordComma

#

# Checks for the lack of an Oxford comma. In some cases, will catch overly complex sentence structures with lots of commas.

# Warning: gitlab.UnclearAntecedent

#

# Checks for words that need a noun for clarity.

# Warning: gitlab.Spelling

#

# Checks for possible spelling mistakes in content, not code. Results from links using angle brackets (<https://example.com>) should be corrected.

# Warning: gitlab.SubstitutionWarning

#

# Checks for misused terms or common shorthand that should never be used at GitLab, but can't be flagged as errors.

# Warning: gitlab.Uppercase

#

# Checks for use of all uppercase letters with unknown reason.