Path: ...!eternal-september.org!feeder3.eternal-september.org!news.eternal-september.org!.POSTED!not-for-mail
From: David Brown <david.brown@hesbynett.no>
Newsgroups: comp.unix.shell,comp.unix.programmer,comp.lang.misc
Subject: Re: Python (was Re: I did not inhale)
Date: Wed, 28 Aug 2024 12:45:40 +0200
Organization: A noiseless patient Spider
Lines: 25
Message-ID: <vamv4k$3eo1d$1@dont-email.me>
References: <uu54la$3su5b$6@dont-email.me> <va5108$3tmmd$1@dont-email.me>
 <va51ok$3tqr9$1@dont-email.me> <va5ec2$3vluh$1@dont-email.me>
 <va6q4g$c1a7$1@dont-email.me> <va6rpa$c6bg$1@dont-email.me>
 <va6se9$cb8e$1@dont-email.me> <20240826083330.00004760@gmail.com>
 <vaises$2k7o6$2@dont-email.me> <20240826155113.000005ba@gmail.com>
 <wwvo75eicla.fsf@LkoBDZeT.terraraq.uk> <vak9k9$2ujrs$1@dont-email.me>
 <vakj7g$303sh$1@dont-email.me> <20240827080320.00003fd2@gmail.com>
 <val6u3$33e82$1@dont-email.me> <vam4v9$3avsi$3@dont-email.me>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Injection-Date: Wed, 28 Aug 2024 12:45:41 +0200 (CEST)
Injection-Info: dont-email.me; posting-host="983d16587e2b5335614c42ef9624d181";
	logging-data="3629101"; mail-complaints-to="abuse@eternal-september.org";	posting-account="U2FsdGVkX1+6X5SOKWHBdDYiWHV9BHK2Q4VLNxM9kqc="
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.11.0
Cancel-Lock: sha1:CGxy3YhMEJdLq6u3LXTcbZEFxm4=
Content-Language: en-GB
In-Reply-To: <vam4v9$3avsi$3@dont-email.me>
Bytes: 2745

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.