Re: Let's make it official then... recommend max line length 88

Ralf Gommers <[email protected]> Wed, 1 Nov 2023 21:30:42 +0100
Newsgroups gmane.comp.python.scientific.devel
Message-ID <CABL7CQhMwtx0qRz61-XMR6qRmxGTVPp7ck9tUvfKuf9tgZX=qg@mail.gmail.com>
On Wed, Nov 1, 2023 at 1:46 AM Lucas Colley <[email protected]> wrote:

> Having a documented length to which we stick would make a tangible
> improvement to the new contributor experience.
>

Thanks Lucas. I think that matters.

We touched on this thread in the community meeting just now. We determined
that while the Ruff config says 88 characters, this check is turned off in
CI - it can't be applied anymore because after the move to Ruff all linting
is done on whole files at once. Everyone there was in favour of updating
the docs to say 88, and a large majority in this thread is also in favor.
So I suggest we go ahead and make this change now. It's a minor doc change
at this point that is overall helpful and brings us in line with what most
tools currently do.

Thanks Lucas also for volunteering to open a doc PR for this. Let's merge
that and call it good.

Cheers,
Ralf


> > SciPy is documented to follow the PEP 8 style guidelines
>
> I can attest to reading this, making changes to obey the 79 character
> limit, and later undoing the changes once I found out that up to 88 is
> (currently) 'ok'. I have no preference for a certain number of characters,
> but 88 seems to be favoured by quite a few maintainers and would require no
> changes to what we currently do.
>
> > (Not that I really care for scipy style, but I don't see a reason to make
> > this a new convention in scientific python.)
>
> Would you be happy with Warren's stated scope (updating the SciPy
> developer docs), as long as it isn't intended as a convention to be
> followed by the whole scientific python ecosystem?
>
> If it seems possible that in the near future the ecosystem will adopt a
> different convention (79, 80 or some other number that isn't 88), then I
> can see an argument for holding off here.
>
> If not, then I see no reason to block this improvement to the new
> contributor experience (which is a correction to inaccurate documentation,
> given that "there is currently a lot [of] code where the guideline is
> violated" and it is not currently enforced at all).
>
> Cheers,
> Lucas (@lucascolley)
> _______________________________________________
> SciPy-Dev mailing list -- [email protected]
> To unsubscribe send an email to [email protected]
> https://mail.python.org/mailman3/lists/scipy-dev.python.org/
> Member address: [email protected]
>

_______________________________________________
SciPy-Dev mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/scipy-dev.python.org/
Member address: [email protected]