[Dev] use of triple quotes for comments

Donn Denman donn at osafoundation.org
Thu Sep 22 16:17:41 PDT 2005


So, what will we use for multi-line comments that are not supposed to  
be doc-strings?

On Sep 22, 2005, at 1:16 PM, Mike Taylor wrote:

> Ok, it's been a couple of days and I've seen 3 yeas, 0 nays and 0  
> don't cares
>
> I'll take that as a yes vote and start doing the changes tonight.   
> I'll be doing the changes in chunks to minimize the impact on  
> everyone.
>
> thanks,
>
> On Sep 20, 2005, at 1:49 PM, Mike Taylor wrote:
>
>
>> As I've been going thru and fixing epydoc generation errors I have  
>> run across a "style" of using triple quotes for comments:
>>
>> def foo():
>>     """
>>     this is the doc string
>>     """
>>     a = 1
>>     """this is a comment - not even multi-line"""
>>     b = 2
>>     """another comment
>>     and it happens to be multi-line"""
>>
>> Now I understand this may be a style issue, but I would like to  
>> change all non-docstring uses of triple quotes to a proper comment.
>>
>> yea? nay? don't care?
>>
>> ---
>> Bear
>>
>> Build and Release Engineer
>> Open Source Applications Foundation (OSAF)
>> bear at osafoundation.org
>> http://www.osafoundation.org
>>
>> bear at code-bear.com
>> http://code-bear.com
>>
>> PGP Fingerprint = 9996 719F 973D B11B E111  D770 9331 E822 40B3 CD29
>>
>> _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
>>
>> Open Source Applications Foundation "Dev" mailing list
>> http://lists.osafoundation.org/mailman/listinfo/dev
>>
>>
> ---
> Bear
>
> Build and Release Engineer
> Open Source Applications Foundation (OSAF)
> bear at osafoundation.org
> http://www.osafoundation.org
>
> bear at code-bear.com
> http://code-bear.com
>
> PGP Fingerprint = 9996 719F 973D B11B E111  D770 9331 E822 40B3 CD29
>
>
> _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
>
> Open Source Applications Foundation "Dev" mailing list
> http://lists.osafoundation.org/mailman/listinfo/dev
>



More information about the Dev mailing list