diff options
Diffstat (limited to 'tags/d/description-synopsis-starts-with-article.tag')
| -rw-r--r-- | tags/d/description-synopsis-starts-with-article.tag | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/tags/d/description-synopsis-starts-with-article.tag b/tags/d/description-synopsis-starts-with-article.tag new file mode 100644 index 0000000..c660c17 --- /dev/null +++ b/tags/d/description-synopsis-starts-with-article.tag @@ -0,0 +1,10 @@ +Tag: description-synopsis-starts-with-article +Severity: warning +Check: fields/description +Explanation: The first line of the "Description:" should omit any initial indefinite + or definite article: "a", "an", or "the". A good heuristic is that it should + be possible to substitute the package <code>name</code> and <code>synopsis</code> + into this formula: + . + The package <code>name</code> provides {a,an,the,some} <code>synopsis</code>. +See-Also: developer-reference 6.2.2 |