Differential D40063 Diff 121862 documentation/content/en/books/fdp-primer/writing-style/_index.adoc

Changeset View

Standalone View

documentation/content/en/books/fdp-primer/writing-style/_index.adoc

	Show First 20 Lines • Show All 281 Lines • ▼ Show 20 Lines
	\| warning			\| warning

	\| FreeBSD.Spacing			\| FreeBSD.Spacing
	\| error			\| error

	\| FreeBSD.SuperfluousOptArgInLinks			\| FreeBSD.SuperfluousOptArgInLinks
	\| suggestion			\| suggestion

	\| FreeBSD.Weasel
	\| warning

	\| Vale.Avoid			\| Vale.Avoid
	\| error			\| error

	\| Vale.Repetition			\| Vale.Repetition
	\| error			\| error

	\| Vale.Spelling			\| Vale.Spelling
	\| error			\| error
	Show All 21 Lines
	. FreeBSD.Hang: `Hang` is often used to mean that the application has stopped responding.			. FreeBSD.Hang: `Hang` is often used to mean that the application has stopped responding.
	This rule proposes better wording.			This rule proposes better wording.

	. FreeBSD.Hyphens: Often adverbs ending with 'ly' are added with a hyphen which is wrong.			. FreeBSD.Hyphens: Often adverbs ending with 'ly' are added with a hyphen which is wrong.

	. FreeBSD.Spacing: Often double spaces are hard to catch with the naked eye and this is addressed here.			. FreeBSD.Spacing: Often double spaces are hard to catch with the naked eye and this is addressed here.

	. FreeBSD.SuperfluousOptArgInLinks: Suggest to empty square brackets in `link:` macros when the displayed text coincides with the URL.			. FreeBSD.SuperfluousOptArgInLinks: Suggest to empty square brackets in `link:` macros when the displayed text coincides with the URL.

	. FreeBSD.Weasel: This rule is aimed at avoiding weasel words.
	The concept of weasel words is controversial so at the moment the list of words are being evaluated and the severity level is marked as warning only.
	If a frequently used word is marked as a weasel word it should be removed from [.filename]#.vale/styles/FreeBSD/Weasel.yml# in the `doc` repository.

	. Vale.Avoid: Enforces the DO NOT USE vocabulary terms for The FreeBSD Project.			. Vale.Avoid: Enforces the DO NOT USE vocabulary terms for The FreeBSD Project.
	If any word is found that should not be n the documentation the word should be added to the [.filename]#.vale/styles/Vocab/Terms/reject.txt# in the `doc` repository.			If any word is found that should not be n the documentation the word should be added to the [.filename]#.vale/styles/Vocab/Terms/reject.txt# in the `doc` repository.
	The list is empty at the moment.			The list is empty at the moment.

	. Vale.Repetition: Same words are often typed twice when leaving the keyboard and rejoining the work again.			. Vale.Repetition: Same words are often typed twice when leaving the keyboard and rejoining the work again.
	This rule finds repeated words and warns the users.			This rule finds repeated words and warns the users.

	▲ Show 20 Lines • Show All 43 Lines • Show Last 20 Lines