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

Ensure all APIs have safety notes #![deny(clippy::missing_safety_doc)] #698

Closed
kngwyu opened this issue Dec 23, 2019 · 3 comments · Fixed by #1690
Closed

Ensure all APIs have safety notes #![deny(clippy::missing_safety_doc)] #698

kngwyu opened this issue Dec 23, 2019 · 3 comments · Fixed by #1690

Comments

@kngwyu
Copy link
Member

kngwyu commented Dec 23, 2019

We have many unsafe APIs but they have poorly documented with their safe precondition, which makes clippy unhappy.
image

I don't think we need to address all those warnings, but maybe it is variable to add #Safety section to common unsafe APIs!

@davidhewitt davidhewitt changed the title Address clippy warning: unsafe function's docs miss # Safety section Ensure all APIs have safety notes #![deny(clippy::missing_safety_doc)] Aug 6, 2020
@davidhewitt
Copy link
Member

It would be really cool to try and achieve this in 0.13.

@davidhewitt davidhewitt added this to the 0.13 milestone Sep 1, 2020
@davidhewitt davidhewitt modified the milestones: 0.13, 0.14 Dec 22, 2020
@davidhewitt davidhewitt modified the milestones: 0.14, 0.15 Apr 13, 2021
@mejrs
Copy link
Member

mejrs commented Jun 10, 2021

afaik, there are just two of these left:

@davidhewitt
Copy link
Member

davidhewitt commented Jun 10, 2021

Oh nice, I hadn't noticed we were so close!

For 1. I was thinking of tidying up the pyclass_slots stuff so maybe I can sort that at the same time. It has to be a valid python object of the right type.

  1. is removed in pyclass: refactor tp_new / tp_dealloc / remove PyCellInner #1657

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants