Usage tip o' the day

Paul W. Frields stickster at gmail.com
Wed Nov 26 13:15:51 UTC 2008


On Wed, Nov 26, 2008 at 03:19:09PM +1000, Christopher Curran wrote:
> Paul W. Frields wrote:
>> On Wed, Nov 26, 2008 at 11:58:12AM +1000, Murray McAllister wrote:
>>   
>>>>> CORRECT:    "To test new packages before they are pushed to the stable
>>>>> repository, turn on the 'updates-testing' repository in the Software
>>>>> Sources tool."
>>>>>         
>>>> More correct: "Test packages not pushed to the 'stable' respository by
>>>> turning on the 'updates-testing' repository. "
>>>>       
>>> I do not think this is correct. It makes it sound like there are "test
>>> packages" that are not pushed to stable, instead of users "testing the
>>> packages".
>>
>> I thought the same thing when I read it.  One must often balance the
>> desire for brevity with the need for clarity.
>>   
> Admittedly, my example was not all that great but my point is no less  
> valid. Do not use 20 words when ten will suffice.

I agree completely with this guideline.  Short, declarative sentences
deliver information clearly and succinctly.

-- 
Paul W. Frields                                http://paul.frields.org/
  gpg fingerprint: 3DA6 A0AC 6D58 FEC4 0233  5906 ACDB C937 BD11 3717
  http://redhat.com/   -  -  -  -   http://pfrields.fedorapeople.org/
  irc.freenode.net: stickster @ #fedora-docs, #fedora-devel, #fredlug
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/fedora-docs-list/attachments/20081126/abfe038f/attachment.sig>


More information about the fedora-docs-list mailing list