Make sure Rust-based find_paths function is included in docs
#170
Conversation
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
ppinchuk
added
enhancement
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #170 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 17 17
Lines 1443 1443
Branches 170 170
=========================================
Hits 1443 1443
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR ensures that the Rust-based find_paths function appears correctly in the Sphinx-generated documentation by addressing its module attribution and improving documentation formatting.
Key changes:
- Monkeypatched
find_paths.__module__to"revrt"for proper Sphinx autodoc inclusion - Added consistent formatting (blank line after rubric) in the Sphinx module template
- Updated type annotations in Rust docstrings to use
list of tupleformat
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| revrt/init.py | Monkeypatches find_paths.__module__ to ensure the Rust function appears under the revrt module in documentation |
| docs/source/_templates/custom-module-template.rst | Adds consistent blank line formatting after the Modules rubric, matching other sections |
| crates/revrt/src/ffi.rs | Updates type annotations in docstrings from list of (int, int) to list of tuple |
castelao
approved these changes
Dec 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Because the function was put under the private
_rustmodule, it was not being included in the documentation. IN this PR, we monkeypatch the module for that function so that it gets included correctly