Developers of Sympa

["Stefan Hornburg (Racke)" <address@concealed>]

On 6/8/19 3:20 PM, IKEDA Soji wrote:
> Hi,
> 
> 2019/06/08 0:07、Luc Didry <address@concealed>のメール:
> 
>> Hello,
>>
>> I personally don’t like to have POD at the end of the files:
>> - it makes you go below the function you’re hacking to see its
>>  description
>> - it can make a huge block of POD to look into. If you add a function,
>>  you have to search where to insert your POD.
>>
>> What would you think if I work on moving POD parts just above the
>> functions it describes?
>>
>> It’s purely aesthetic, but I think it could ease Sympa hacking (like
>> my tt2 indentation PR).
>>
>> Spoiler: you can say "I prefer POD at the end", it won’t hurt me 😉
> 
> Ok, I say I prefer to POD at the end of source. :-)
> 
> POD is hard to read and markup by its nature (i.e. harder than such as 
> comment 
> block with Python).
> 
> - If a “=cut” line was omitted, the rest of code might be ignored.
>   It may invite silly bug.
> - Where may we put POD blocks except description of each function
>   (preamble and remaining items) in the source?
> - POD text would be chopped in the middle of its sections (such as just 
> after
>   heading) and those particles would be inserted in cracks of code.
>   It’s complicating to edit.
> 
> That’s why I don’t prefer to the code often interrupted by PODs.
> 
> (If coverage of documentation matters, we may run pod::coverage tests.)
> 
> Folks, what do you think?

=cut mistakes can be easily spotted by proper tests. Syntax highlighting 
should also
help to prevent these kind of problems.

The other two points you mention is more or less a personal preference. I 
don't like
scrolling a lot for editing PODs for example.

Running POD coverage is an idea we could follow up with in any case.

Regards
        Racke

> 
> Regards,
> 
> —- Soji
> 
>> -- 
>> Luc
>> "La route est longue, mais la voie est libre…" https://framasoft.org
>>
>> Framasoft ne vit que par vos dons (déductibles des impôts). Merci d'avance 
>> pour votre soutien https://soutenir.framasoft.org
>>
>>
>>
>>
> 
> 
> 


-- 
Ecommerce and Linux consulting + Perl and web application programming.
Debian and Sympa administration. Provisioning with Ansible.

Attachment: signature.asc
Description: OpenPGP digital signature