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.

Sign up for GitHub

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

Jump to bottom

Document unsafe code #447

Closed
tcharding opened this issue Jun 10, 2022 · 1 comment · Fixed by #524
Closed

Document unsafe code #447

tcharding opened this issue Jun 10, 2022 · 1 comment · Fixed by #524

Comments

@tcharding
Copy link
Member

tcharding commented Jun 10, 2022 •
edited

We have a whole bunch of unsafe code and non of the safety preconditions are documented.

If #448 merges, remove the compiler attributes in main crate and also secp256k1-sys crate that allow the lint: #![allow(clippy::missing_safety_doc)].
@Kixunil
Copy link
Collaborator

Kixunil commented Jun 10, 2022

Doing unsafe code review while documenting would be interesting for me. Reminds me #359 is still open.

@tcharding tcharding mentioned this issue Nov 21, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document unsafe code tcharding/rust-secp256k1
2 participants
@Kixunil @tcharding