diff options
Diffstat (limited to 'tags/s/synopsis-is-a-sentence.tag')
| -rw-r--r-- | tags/s/synopsis-is-a-sentence.tag | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/tags/s/synopsis-is-a-sentence.tag b/tags/s/synopsis-is-a-sentence.tag new file mode 100644 index 0000000..8a351a5 --- /dev/null +++ b/tags/s/synopsis-is-a-sentence.tag @@ -0,0 +1,15 @@ +Tag: synopsis-is-a-sentence +Severity: info +Check: fields/description +Renamed-From: description-synopsis-might-not-be-phrased-properly +Explanation: The package synopsis (also known as the "short" description, ie. the + first line in the package's "Description:" field) either ends with a full + stop "." character or starts another sentence. + . + This is not necessary as the synopsis does not need to be a full + sentence. It is recommended that a single descriptive phrase is used + instead. + . + Note also that the synopsis is not part of the rest of the "long" + Description: field. +See-Also: developer-reference 6.2.2 |