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

Update documentation and make method names more expressive. #142

Merged
merged 2 commits into from
Sep 15, 2024

Conversation

Alexhuszagh
Copy link
Owner

@Alexhuszagh Alexhuszagh commented Sep 15, 2024

This ensures any ambiguity from the method names would not cause potential issues among maintainers. There's 2 abstractions that contain 193/250 of the unsafe expressions and everything is clearly documented and the safety requirements are clearly documented and effectively every call of these unsafe methods is made within the trait/struct.

For example, in Bigint, the majority of the "unsafety" are methods like push_unchecked, pop_unchecked, and extend_unchecked, which are only called by try_push, pop, and try_extend, respectively. The same logic extends for essentially the entire implementation.

Closes #100
Closes #138

This ensures any ambiguity from the method names would not cause
potential issues among maintainers.
@Alexhuszagh Alexhuszagh added documentation Fix in the documentation A-sec Issues with potential security implications. labels Sep 15, 2024
@Alexhuszagh Alexhuszagh added this to the 1.0.1 milestone Sep 15, 2024
@Alexhuszagh Alexhuszagh self-assigned this Sep 15, 2024
@Alexhuszagh Alexhuszagh merged commit e3f01cb into main Sep 15, 2024
39 checks passed
@Alexhuszagh Alexhuszagh deleted the optunsafe branch September 15, 2024 23:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-sec Issues with potential security implications. documentation Fix in the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[SAFETY] Tracking Unsafe Code [OTHER] Improve internal safety comments and architecture
1 participant