FAQ Search Today's Posts Mark Forums Read
» Video Reviews

» Linux Archive

Linux-archive is a website aiming to archive linux email lists and to make them easily accessible for linux users/developers.


» Sponsor

» Partners

» Sponsor

Go Back   Linux Archive > Debian > Debian Development

 
 
LinkBack Thread Tools
 
Old 02-02-2008, 06:55 AM
Ben Finney
 
Default Package synopsis: appositive clause, not full sentence (was: Bug#463666: ITP: tomoe -- Tomoe - A handwriting recognition engine)

Christian Perrier <bubulle@debian.org> writes:

> Quoting NIIBE Yutaka (gniibe@fsij.org):
> > Description :
>
> Apparently your proposed synopsis for the package is "-- Tomoe - A
> handwriting recognition engine". May I suggest a simpler and more
> "standard" one:
>
> handwriting recognition engine

Yes.

In general, all Debian packages should follow the Debian Developer's
Reference guide on package descriptions:

It's a good idea to think of the synopsis as an appositive clause,
not a full sentence. An appositive clause is defined in WordNet as
a grammatical relation between a word and a noun phrase that
follows, e.g., "Rudolph the red-nosed reindeer". The appositive
clause here is "red-nosed reindeer". Since the synopsis is a
clause, rather than a full sentence, we recommend that it neither
start with a capital nor end with a full stop (period). It should
also not begin with an article, either definite ("the") or
indefinite ("a" or "an").

<URL:http://www.debian.org/doc/developers-reference/ch-best-pkging-practices.en.html#s-bpp-pkg-synopsis>

--
"For fast acting relief, try slowing down." —Jane Wagner, |
` via Lily Tomlin |
_o__) |
Ben Finney


--
To UNSUBSCRIBE, email to debian-devel-REQUEST@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org
 

Thread Tools




All times are GMT. The time now is 09:40 AM.

VBulletin, Copyright ©2000 - 2014, Jelsoft Enterprises Ltd.
Content Relevant URLs by vBSEO ©2007, Crawlability, Inc.
Copyright ©2007 - 2008, www.linux-archive.org