Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved rust docs and method visibility #119

Merged
merged 1 commit into from
Aug 13, 2024
Merged

Conversation

kylebarron
Copy link
Owner

@kylebarron kylebarron commented Aug 13, 2024

Change list

  • Convert nearly all methods exported to Python via arro3-core to non-public Rust visibility
  • Add #![deny(missing_docs)] and add Rust docstrings
  • Add allow_inspection: false to the mkdocs.yml config so that the Rust docstrings aren't used for Python docs.

@kylebarron kylebarron merged commit 963f477 into main Aug 13, 2024
3 checks passed
@kylebarron kylebarron deleted the kyle/rust-docs-visibility branch August 13, 2024 03:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant