Re: Bug#501121: jd: package description inadequate
Justin B Rye <jbr@edlug.org.uk> writes:
> Ben Finney wrote:
> > Description: simple browser for “2ch-style” web forum sites
> > JD is a simple browser allowing easy use of “2ch-style” web
> > forum sites. Its features include:
>
> A bit repetitive.
If you mean the long description repeats what the synopsis says,
that's normal. The two should be meaningful each without the other.
> > .
> > * log in
> > * message view/post
> > * image view
>
> Reading "log in" as a verb makes the list a mix of verbs and nouns.
> Also, keep the "ing"s on "viewing", "posting" ("image view" might
> mean "a mode that displays things as if they were images").
Yes, that makes sense.
> (Oh, and we seem to have arbitrarily standardised on hyphens as
> bulletpoints.)
Not true; the consensus has settled on each of the three characters
‘*’, ‘+’, ‘-’ as valid for bullet lists in Description fields. See
<URL:http://lists.debian.org/debian-devel/2005/12/msg00531.html> and
ensuing discussion.
I find that ‘*’ is best for readability, especially in a Description
field which often also has ‘.’ characters in roughly the same column.
I don't have any strong opinion on which to use, though, and use all
three on occasion.
> > * mouse gestures
> > * ignore lists
> > * “play-by-play” mode
>
> What happened to the bit about server workloads?
Omitted accidentally.
I also have no idea what “play-by-play” mode is supposed to be. I
trust the package maintainer feels that those readers interested in a
“2ch-style” web forum site will already know what this term means
without further explanation?
> > * 2channel <http://www.2ch.net>
> > * Shitaraba <http://rentalbbs.livedoor.com/jbbs/>
> > * Machi-BBS <http://www.machi.to/>
>
> No need for any sort of brackets on the URLs.
It's actually standard to use angle brackets to enclose URLs in the
context of surrounding text, as specified by RFC 3986
<URL:http://tools.ietf.org/html/rfc3986#appendix-C>. It also has the
benefit of flowing better on reading (for this reader, anyway) than
with no bracketing at all.
Current suggestion:
Description: simple browser for “2ch-style” web forum sites
JD offers a comfortable browsing experience on 2ch-style web
forum sites. Its features include:
.
* automated login
* message viewing/posting
* image viewing
* mouse gestures
* ignore lists
* “play-by-play” mode
.
It can also significantly reduce the load on servers by bypassing
CGI programs and directly retrieving thread data files to your
local hard drives.
.
“2ch-style” web forum sites have their origins in 2channel,
which is a very popular Internet forum in Japan. Such sites are
often available only in the Japanese language. For example:
.
* 2channel <http://www.2ch.net>
* Shitaraba <http://rentalbbs.livedoor.com/jbbs/>
* Machi-BBS <http://www.machi.to/>
--
\ “Don't worry about what anybody else is going to do. The best |
`\ way to predict the future is to invent it.” —Alan Kay |
_o__) |
Ben Finney
Reply to: