[scikit-learn] Experience with black formatting in scikit-learn for astropy

[Guillaume Lemaître]

I just answer in the text below. This is my 2c.

Hope this helps

Cheers,

On Wed, 18 May 2022 at 22:08, Tom Aldcroft <taldcroft at gmail.com> wrote:

> Hi -
>
> The astropy core is currently considering implementing code formatting
> with black, much as scikit-learn did in 2020 (
> https://github.com/scikit-learn/scikit-learn/pull/18948). Not
> surprisingly there are a wide range of opinions and concerns.
>
> My goal in writing is to request feedback from the scikit-learn community
> about how this transition has impacted development and community engagement
> in the time since the transition.
>
> Has there been specific feedback from contributors (both experienced and
> new) related to black autoformatting?
>
>    - Ease of actually running black and meeting the black-format standard
>    for PRs. Have there been contributor problems that required assistance?
>
> I think that this is the main drawback. One can argue that using
`pre-commit` will do all the necessary changes but we still get
contributors pushing without `pre-commit` being installed and stalled with
an Azure CI. Since the CI could be quite overwhelming for new contributors,
I could consider this part as an additional entrance barrier.

>
>    - Style considerations?
>
> I assume that you get used to it even if anyone might get a little cranky
on some styling at first. At least, it allows having any discussion
regarding (some) style coding during PR reviews. I think that this is the
main advantage for us.


>
>    - Technical problems like backports?
>
> Not really. I think that it was quite smooth. We only get a commit in the
history that is annoying while trying to blame with `git`.



> Are there any regrets or things you would change?
>

Personally not ;). We might intend to use `isort` even.


> Do you have any advice for the astropy project?
>
> Any feedback from your experience would be most appreciated, especially
> coming from a more science-oriented project like scikit-learn (as opposed
> to other large projects like django or pytest that have also adopted black).
>
> Cheers,
> Tom (@taldcroft on GitHub)
>
> _______________________________________________
> scikit-learn mailing list
> scikit-learn at python.org
> https://mail.python.org/mailman/listinfo/scikit-learn
>


-- 
Guillaume Lemaitre
Scikit-learn @ Inria Foundation
https://glemaitre.github.io/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.python.org/pipermail/scikit-learn/attachments/20220519/b3527d02/attachment.html>