👷 Auto-commit pyfiction docstrings

[simon1hofmann]

Description

Auto-commit new pyfiction docstrings directly to your branch in a PR.

Checklist:

• The pull request only contains commits that are related to it.
• I have added appropriate tests and documentation.
• I have created/adjusted the Python bindings for any new or updated functionality.
• I have made sure that all CI jobs on GitHub pass.
• The pull request introduces no new warnings and follows the project's style guidelines.

[github-actions]

clang-tidy review says "All clean, LGTM! 👍"

[simon1hofmann]

@marcelwa Can we prioritize the run of pyfiction-docstring-generator.yml in some way? Otherwise, in the worst case, every CI will run again if pyfiction-docstring-generator.yml is the final CI to be run.

[github-actions]

clang-tidy review says "All clean, LGTM! 👍"

[marcelwa]

@marcelwa Can we prioritize the run of pyfiction-docstring-generator.yml in some way? Otherwise, in the worst case, every CI will run again if pyfiction-docstring-generator.yml is the final CI to be run.

We can make other workflows depend on this one. I.e. they are going to be stalled until this one finishes. Is that what we want?

[simon1hofmann]

@marcelwa Can we prioritize the run of pyfiction-docstring-generator.yml in some way? Otherwise, in the worst case, every CI will run again if pyfiction-docstring-generator.yml is the final CI to be run.

We can make other workflows depend on this one. I.e. they are going to be stalled until this one finishes. Is that what we want?

I think we don't have to necessarily stall the Ubuntu, Windows and macOS CI's, as updating pybind_11_mkdoc_docstrings does not change anything in the normal C++ build, so it should be enough to prevent rerunning them every time pybind_11_mkdoc_docstrings is updated?

Only the pyfiction CI's and the documentation build have to be stalled unitl the new docstrings have been generated.

[marcelwa]

@marcelwa Can we prioritize the run of pyfiction-docstring-generator.yml in some way? Otherwise, in the worst case, every CI will run again if pyfiction-docstring-generator.yml is the final CI to be run.

We can make other workflows depend on this one. I.e. they are going to be stalled until this one finishes. Is that what we want?

I think we don't have to necessarily stall the Ubuntu, Windows and macOS CI's, as updating pybind_11_mkdoc_docstrings does not change anything in the normal C++ build, so it should be enough to prevent rerunning them every time pybind_11_mkdoc_docstrings is updated?

Only the pyfiction CI's and the documentation build have to be stalled unitl the new docstrings have been generated.

I don't know out of the top of my head how to do this. We have certain file patterns at the top of most CI configuration files that trigger these workflows on change. Maybe that's a good starting point for you to look into.

[simon1hofmann]

@marcelwa Can we prioritize the run of pyfiction-docstring-generator.yml in some way? Otherwise, in the worst case, every CI will run again if pyfiction-docstring-generator.yml is the final CI to be run.

We can make other workflows depend on this one. I.e. they are going to be stalled until this one finishes. Is that what we want?

I think we don't have to necessarily stall the Ubuntu, Windows and macOS CI's, as updating pybind_11_mkdoc_docstrings does not change anything in the normal C++ build, so it should be enough to prevent rerunning them every time pybind_11_mkdoc_docstrings is updated?
Only the pyfiction CI's and the documentation build have to be stalled unitl the new docstrings have been generated.

I don't know out of the top of my head how to do this. We have certain file patterns at the top of most CI configuration files that trigger these workflows on change. Maybe that's a good starting point for you to look into.

It should be possible to exclude specific paths, I've updated the corresponding workflows.

[marcelwa]

@marcelwa Can we prioritize the run of pyfiction-docstring-generator.yml in some way? Otherwise, in the worst case, every CI will run again if pyfiction-docstring-generator.yml is the final CI to be run.

We can make other workflows depend on this one. I.e. they are going to be stalled until this one finishes. Is that what we want?

I think we don't have to necessarily stall the Ubuntu, Windows and macOS CI's, as updating pybind_11_mkdoc_docstrings does not change anything in the normal C++ build, so it should be enough to prevent rerunning them every time pybind_11_mkdoc_docstrings is updated?
Only the pyfiction CI's and the documentation build have to be stalled unitl the new docstrings have been generated.

I don't know out of the top of my head how to do this. We have certain file patterns at the top of most CI configuration files that trigger these workflows on change. Maybe that's a good starting point for you to look into.

It should be possible to exclude specific paths, I've updated the corresponding workflows.

Many thanks! 🙏

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.29%. Comparing base (a4c4838) to head (7774b94).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #420   +/-   ##
=======================================
  Coverage   98.28%   98.29%           
=======================================
  Files         211      211           
  Lines       28578    28576    -2     
  Branches     1319     1319           
=======================================
- Hits        28089    28088    -1     
+ Misses        489      488    -1     

see 4 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a4c4838...7774b94. Read the comment docs.

[github-actions]

clang-tidy review says "All clean, LGTM! 👍"

[github-actions]

clang-tidy review says "All clean, LGTM! 👍"

[marcelwa]

@simon1hofmann would you mind resolving the conflict with the pybind11_mkdoc_docstring.hpp file now that wiring reduction was merged into main?

[simon1hofmann]

pre-commit.ci autofix

[github-actions]

clang-tidy review says "All clean, LGTM! 👍"

[github-actions]

clang-tidy review says "All clean, LGTM! 👍"