GNU bug report logs - #31121
[PATCH 1/3] gnu: Add python2-urlgrabber

Previous Next

Full log

View this message in rfc822 format

From: Marius Bakke <mbakke <at> fastmail.com>
To: Tomáš Čech <sleep_walker <at> gnu.org>
Cc: Tomáš Čech <sleep_walker <at> gnu.org>, 31121 <at> debbugs.gnu.org
Subject: [bug#31121] [PATCH 1/3] gnu: Add python2-urlgrabber
Date: Tue, 17 Apr 2018 01:13:22 +0200

[Message part 1 (text/plain, inline)]

Tomáš Čech <sleep_walker <at> gnu.org> writes:

>>> +    (description "URL grabber library unifying http://, ftp:// and file://
>>> +protocols access, supporting HTTP keepalive, reget, throttling and other
>>> +convenience features.")
>>
>>Please turn this into one or more complete sentences.
>>E.g. "@code{urlgrabber} is a Python library that unifies access to
>>...  It supports bla bla.".
>
> To be honest, this is always the most painful part for me. I'll try to come with something better.

Descriptions *are* difficult, especially for tools you are unfamiliar
with.  It does not help that upstream descriptions are often targeting a
highly specialized demographic, whereas we are catering for a much wider
audience.  I try to make them generic, and include some information
about why the user would want this package/how it's used.

Occasionally I'll browse the packages at gnu.org/s/guix for inspiration.
(or look at Debians description, but don't tell anyone)

Writing the code is comparatively easy :-)

[signature.asc (application/pgp-signature, inline)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.