style: add pre-commit configuration - #70
Draft
henryiii wants to merge 1 commit into
Draft
Conversation
Model the configuration on pybind11's, without the hooks that have no targets here (clang-format, shellcheck, pylint, rst checks). Exclude tests/*_docs/ fixtures, which are compared byte-for-byte against generated output. Apply the resulting fixes, including some real spelling corrections, and replace the hatch-fmt CI job with a prek lint job. Assisted-by: ClaudeCode:claude-fable-5
leakec
reviewed
Aug 12, 2026
| # | ||
| # The optional parameters are: | ||
| # * EXTRA_ARGS - A list of arguments that will be added verbatim to the pybind11-mkdoc command. | ||
| # The optional parameters are: * EXTRA_ARGS - A list of arguments that will be |
Collaborator
There was a problem hiding this comment.
This was meant to be a bulleted list, so the original newline here was intentional. Maybe if I use - then it won't reformat?
leakec
reviewed
Aug 12, 2026
Comment on lines
+15
to
+18
| # Example usage: pybind11_add_module(my_pybind11_module | ||
| # src/my_pybind11_module.cc) pybind11_mkdoc( OUTPUT my_pybind11_module_doc.h | ||
| # PYBIND11_MODULE my_pybind11_module HEADERS include/my_header_1.h | ||
| # /absolute/path/to/header.h ) |
Collaborator
There was a problem hiding this comment.
Not sure if it is possible to preserve the original format here in the comments, but I felt it made things more readable.
Collaborator
Author
There was a problem hiding this comment.
Ahh, this requires a config file, I forgot about that.
leakec
reviewed
Aug 12, 2026
| # | ||
| # The optional parameters are: | ||
| # * EXTRA_ARGS - A list of arguments that will be added verbatim to the pybind11-mkdoc command. | ||
| # The optional parameters are: * EXTRA_ARGS - A list of arguments that will be |
Collaborator
There was a problem hiding this comment.
Same comment as before, this is meant to be a bulleted list.
leakec
reviewed
Aug 12, 2026
Comment on lines
+15
to
+18
| # Example usage: pybind11_add_module(my_pybind11_module | ||
| # src/my_pybind11_module.cc) pybind11_mkdoc( OUTPUT my_pybind11_module_doc.h | ||
| # PYBIND11_MODULE my_pybind11_module HEADERS include/my_header_1.h | ||
| # /absolute/path/to/header.h ) |
Collaborator
There was a problem hiding this comment.
Same comment as before. I think the original version was more readable.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🤖 AI text below 🤖
Add a
.pre-commit-config.yamlmodeled on pybind11's, without the hooks that have no targets here (clang-format, shellcheck, pylint, rst checks). Thetests/*_docs/fixtures are excluded because they are compared byte-for-byte against generated output.Beyond the automatic reformatting, this fixes real typos found by codespell/typos ("absoulte", "exmaple") in the README and cmake function files, and replaces the
hatch fmtCI job with aprek run -alint job so CI matches the hooks.