Closed adrianusler closed 6 months ago
[!IMPORTANT]
Auto Review Skipped
Review was skipped due to path filters
Files ignored due to path filters (1)
* `pyproject.toml` is excluded by `!**/*.toml`
The recent update focuses on enhancing the project's documentation and code management practices. It shifts the docstring style preference from Google-style to Sphinx, aiming for more structured and consistent documentation. Additionally, it modifies the branch naming strategy for feature and bug fix branches, transitioning from hyphens to slashes, which could streamline branch categorisation and retrieval.
Files | Change Summary |
---|---|
CONTRIBUTING.md |
Updated docstring style to Sphinx format; Changed branch naming convention from hyphens to slashes for features and bug fixes. |
🐰✨
In the land of code, where ideas merge and flow,
A small but mighty change did show.
From Google's style, we take a leap,
To Sphinx's embrace, a change not so steep.
With slashes and paths, our branches we name,
A rabbit's touch, in the documentation game.
🌟📚
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 68.11%. Comparing base (
fc68613
) to head (8c58c8b
).
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
@Michel-Heinz if you also want to have your e-mail listed in pyproject.toml, you can add it to this PR (so did I)
Closes #296.
Summary by CodeRabbit