Re: Python (was Re: I did not inhale)

On 28/08/2024 05:19, Sebastian wrote:

In comp.unix.programmer David Brown <david.brown@hesbynett.no> wrote:

>
It is not common to have to have indent comment lines (certainly in
Python it is not necessary).  And if you find yourself writing large
comments in the middle of a block in the middle of a function, it is
probably time to consider re-organising the code and/or the comments and
documentation.  (Again, there can be exceptions to this general rule.)
>

 It may not be "common" (ie, not a lot of languages have this requirement),
but if it's your job to maintain a project written in such a language,
then you'll have to deal with that problem every single day.

If you have some code that needs a lot of documentation (and some does), then put the comments in a place that does not interfere with reading and understanding the code.  Comments that make code harder to read are counter-productive.
Where these comments end up - elsewhere in the function, outside the function, at the head of the file, in a separate file, in completely separate documentation - depends on the situation.