DOC: Style guide could indicate formatters / pre-commit hook #21424
Comments
|
There is a CI linter job that runs a script |
|
Thank you for the links, makes sense about the incremental changes. If there is a goal of eventually having some sort of format, darker exists which runs black & isort only on changed lines, and can be a precommit hook or an editor plugin. There's also a way to do the same for a hook with clang-format, which would allow for your comment in #19754 (comment) If it's not a "hard no" to have some sort of optional incremental formatter, then I'll come up with a sample config file to at least test out |
|
Some of these suggestions have been applied incrementally:
Not done yet:
It remains unclear if there is interest in pre-commit hooks, and whether they should be enforced by pre-commit.ci or the official GitHub Action https://github.com/pre-commit/action. The latter is in maintenance mode so I wouldn't recommend it. |
|
I would recommend against using pre-commit actually. See numpy/numtype#388 (comment) and scientific-python/cookie#577 |
|
I'm not a huge fan of pre-commit either, for different reasons, and I have to agree the maintainer is.. difficult. |
Issue with current documentation:
I'm working through my first issue with the project, and struggling to find information on whether there is a recommended formatter. The source currently seems to use a mix of optional styles (single vs. double quotes, backslash vs. brackets, formatting of non-python files, etc.) and I think that some more specific in the docs, possibly with recommended formatters and/or formatter config files, would help to simplify things a bit.
The only reference to style that I found was here: https://numpydoc.readthedocs.io/en/latest/format.html
Idea or request for content:
Plenty of projects use Black to format code, and I don't think that would be a bad idea here. If there are some custom style options that Numpy prefers to stick with, then something like Autopep8 or YAPF would probably be configurable to work.
A simpler option would be to add a precommit hook that handles formatting, just to be able to easier enforce consistency. Even if the hook isn't enforced in the pipeline, it would at least help give devs some direction when working locally. At a minimum, the following hooks would be quite useful:
Optionally, some other nice to have hooks would be:
If there is interest in this, I would be happy to submit a PR. Of course, it is possible that this has been discussed before and there's a reason it doesn't exist. I couldn't find anything in the issues list, but I figure there must be a reason why linter.py is used instead of a precommit hook.
The text was updated successfully, but these errors were encountered: