prose

Comments and documentation: clear dates, link text, and alternative text. Level all adds the complete gspot style and the upstream Vale packages. The Spelling and prose guide explains the setup.

Checks

Check	Stage	Level	What it does
prose/vale	commit	recommended	Checks ambiguous dates, link text, and alternative text with the shipped Vale styles at level recommended. Level all adds the complete style and upstream packages.

Settings

Setting	What it sets
prose.max_sentence_words	The most words one sentence of documentation may have.
prose.max_list_item_words	The most words one list item may have.
prose.max_paragraph_sentences	The most sentences one paragraph may have.

Selected when

Always selected.

Rules for coding agents

Rule file	Installed when
.gspot/configurations/general/prose/rules/WRITING.md	Always

Tools and versions

Tool	Version
vale	3.21.0

Files gspot writes

gspot writes .gspot/configurations/general/prose/vale.ini, .gspot/configurations/general/prose/styles/gspot/acronyms.yml, .gspot/configurations/general/prose/styles/gspot/alt-text.yml, .gspot/configurations/general/prose/styles/gspot/banned-headings.yml, .gspot/configurations/general/prose/styles/gspot/heading-case.yml, .gspot/configurations/general/prose/styles/gspot/item-length.yml, .gspot/configurations/general/prose/styles/gspot/paragraph-length.yml, .gspot/configurations/general/prose/styles/gspot/possessives.yml, .gspot/configurations/general/prose/styles/gspot/sentence-length.yml, .gspot/configurations/general/prose/styles/gspot/title-case.yml, .gspot/configurations/general/prose/styles/config/vocabularies/words/accept.txt, .gspot/configurations/general/prose/styles/gspot/numbered-units.yml, .gspot/configurations/general/prose/styles/gspot/future.yml, .gspot/configurations/general/prose/styles/gspot/modals.yml, .gspot/configurations/general/prose/styles/gspot/product-centric-writing.yml, .gspot/configurations/general/prose/styles/gspot/contractions.yml, .gspot/configurations/general/prose/styles/gspot/hedging.yml, .gspot/configurations/general/prose/styles/gspot/since.yml, .gspot/configurations/general/prose/styles/gspot/leading-conjunctions.yml, .gspot/configurations/general/prose/styles/gspot/date-ordinals.yml, .gspot/configurations/general/prose/styles/gspot/suspended-hyphens.yml, .gspot/configurations/general/prose/styles/gspot/locations.yml, .gspot/configurations/general/prose/styles/gspot/obvious-fields.yml, .gspot/configurations/general/prose/styles/gspot/symbols.yml, .gspot/configurations/general/prose/styles/gspot/merge-conflict-markers.yml, .gspot/configurations/general/prose/styles/gspot/percentage-numbers.yml, .gspot/configurations/general/prose/styles/gspot/militaristic-language.yml, .gspot/configurations/general/prose/styles/gspot/currency.yml, .gspot/configurations/general/prose/styles/gspot/marketing.yml, .gspot/configurations/general/prose/styles/gspot/straight-quotes.yml, .gspot/configurations/general/prose/styles/gspot/placeholders.yml, .gspot/configurations/general/prose/styles/gspot/history.yml, .gspot/configurations/general/prose/styles/gspot/dashes.yml, .gspot/configurations/general/prose/styles/gspot/ordinal-adverbs.yml, .gspot/configurations/general/prose/styles/gspot/interface-verbs.yml, .gspot/configurations/general/prose/styles/gspot/punctuated-headings.yml, .gspot/configurations/general/prose/styles/gspot/file-paths.yml, .gspot/configurations/general/prose/styles/gspot/self-reference.yml, .gspot/configurations/general/prose/styles/gspot/jargon.yml, .gspot/configurations/general/prose/styles/gspot/session-identifiers.yml, .gspot/configurations/general/prose/styles/gspot/url-prepositions.yml, .gspot/configurations/general/prose/styles/gspot/version-range.yml, .gspot/configurations/general/prose/styles/gspot/ampm.yml, .gspot/configurations/general/prose/styles/gspot/time-ranges.yml, .gspot/configurations/general/prose/styles/gspot/conscious-language.yml, .gspot/configurations/general/prose/styles/gspot/idioms.yml, .gspot/configurations/general/prose/styles/gspot/dates.yml, .gspot/configurations/general/prose/styles/gspot/link-text.yml, and .gspot/configurations/general/prose/styles/LICENSES.md.