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

add #[doc(hidden)] to the Rust module created by #[pymodule] #4067

Merged
merged 2 commits into from
Apr 12, 2024

Conversation

Icxolu
Copy link
Contributor

@Icxolu Icxolu commented Apr 10, 2024

This adds #[doc(hidden)] to the Rust module created by #[pymodule]. Given that all items inside of that module already are #[doc(hidden)] I thinks it's reasonable to also hide the module itself too.

Fixes #4063

Copy link
Member

@konstin konstin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

Copy link

codspeed-hq bot commented Apr 10, 2024

CodSpeed Performance Report

Merging #4067 will degrade performances by 10.31%

Comparing Icxolu:fix-4063 (cffaf02) with main (2f0869a)

Summary

❌ 1 regressions
✅ 71 untouched benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

Benchmark main Icxolu:fix-4063 Change
getattr_direct 8.8 µs 9.8 µs -10.31%

@davidhewitt davidhewitt added this pull request to the merge queue Apr 11, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Apr 12, 2024
@davidhewitt davidhewitt added this pull request to the merge queue Apr 12, 2024
Merged via the queue into PyO3:main with commit c8b59d7 Apr 12, 2024
39 of 41 checks passed
@Icxolu Icxolu deleted the fix-4063 branch April 12, 2024 15:50
davidhewitt pushed a commit that referenced this pull request Apr 16, 2024
* add `#[doc(hidden)]` to the Rust module created by `#[pymodule]`

* add newsfragment
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.

#[pyo3::pymodule] triggers missing documentation for a module lint
3 participants