Bug#535439: tvtime: [debconf_rewrite] Debconf templates and debian/control descr

Christian Perrier <[email protected]>
Newsgroups gmane.comp.video.tvtime.devel
Message-ID <[email protected]>
Quoting Bart Martens ([email protected]):
> Hello Christian,
> 
> I'm afraid that the patch does not conform to the best practices
> described here:
> 
> http://www.debian.org/doc/manuals/developers-reference/best-pkging-practices.html#s6.5.4
> 
>         "6.5.4.2.1. String/password templates
>         (...)
>         The extended description is a complement to the short
>         description.
>         In the extended part, explain what is being asked, rather than
>         ask
>         the same question again using longer words."
> 
> So the extended description should not contain "Please choose the TV
> standard to use.", "Please choose the frequency table to use.", ... and
> so on.  Can you get this fixed please ?


I'm sorry but as I did write the best practices you quote, I bet to
disagree..:-)

In some circumstances, and that one is one of these, it has been
accepted that *some* rephrasing of the synopsis is the most
appropriate way to introduce the long description and the elements it
contains.

The DevRef should probably be slightly adapted but the main intent in
what you quote is to discourage long descriptions to *only* repeat
what's in the synopsis.

I understand that may sound a little bit contradictory but please
notice that this style has been used in dozens of "reviewed" templates
as of now and has proven to be the most efficient *with all possible
debconf interfaces*.

------------------------------------------------------------------------------
Enter the BlackBerry Developer Challenge  
This is your chance to win up to $100,000 in prizes! For a limited time, 
vendors submitting new applications to BlackBerry App World(TM) will have
the opportunity to enter the BlackBerry Developer Challenge. See full prize  
details at: http://p.sf.net/sfu/Challenge

_______________________________________________
Tvtime-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/tvtime-devel
signature.asc (application/pgp-signature, 197 B)
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (GNU/Linux)

iEYEARECAAYFAkpbbbcACgkQ1OXtrMAUPS0qAQCeOVsI7WBr7cta/SiuJQppuOtu
OjsAnRrBQCaRMrQih1TVtgM88NAO138S
=yDHz
-----END PGP SIGNATURE-----
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.