Regarding coding style
Steven D'Aprano
steve at REMOVE-THIS-cybersource.com.au
Sun Mar 9 00:54:18 EST 2008
On Sun, 09 Mar 2008 05:29:42 +0000, Grant Edwards wrote:
>> Sure, but really, adding ONE LINE to the start of a file is hardly
>> "cluttering up" anything. Especially if it is in the doc string, like
>> this:
>>
>> """widgets.py: create, manage and destroy widgets.
>>
>> blah blah blah blah..."""
>
> The bad part is that it's redundant information. That means that
> eventually, it's going to be wrong.
I withdraw my defense of including the file name.
After looking at both the Python standard library and my own scripts/
modules, I can see that it is a lot rarer than I thought it was, and even
when I do it, it is almost always in help strings for quick and dirty
scripts.
--
Steven
More information about the Python-list
mailing list