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

Add safety doc #810

Open
amab8901 opened this issue Jan 12, 2023 · 0 comments
Open

Add safety doc #810

amab8901 opened this issue Jan 12, 2023 · 0 comments
Labels
minor tracking an issue or PR used for tracking purposes only

Comments

@amab8901
Copy link
Contributor

amab8901 commented Jan 12, 2023 •
edited

After #806 is merged, search for:

    /// # Safety
    /// [TODO: Add safety documentation]

throughout the entire codebase. And put the safety documentation in the # Safety section. @kevinaboos
kevinaboos pushed a commit that referenced this issue Jan 13, 2023
@amab8901
Address more clippy lints (#806)
a5bba8a 
This commit addresses the following lints:
* `from_over_into`
* `from_over_into`
* `empty_loop`
* `inconsistent_digit_grouping`
* `into_iter_on_ref`
* `iter_nth_zero`
* `iter_skip_next`
* `len_without_is_empty`
* `len_zero`
* `let_and_return`
* `manual_range_contains`
* `let_and_return`
* `map_clone`
* `manual_range_contains`
* `match_like_matches_macro`
* `len_zero`
* `match_ref_pats`
* `mem_replace_with_default`
* `match_like_matches_macro`
* `needless_borrow`

* For `missing_safety_doc` and `empty_loop`, we have opened
  tracking issues for those (#808 and #810), as they will
  require additional more involved changes.
github-actions bot pushed a commit that referenced this issue Jan 13, 2023
@kevinaboos
Address more clippy lints (#806)
297a0df 
This commit addresses the following lints:
* `from_over_into`
* `from_over_into`
* `empty_loop`
* `inconsistent_digit_grouping`
* `into_iter_on_ref`
* `iter_nth_zero`
* `iter_skip_next`
* `len_without_is_empty`
* `len_zero`
* `let_and_return`
* `manual_range_contains`
* `let_and_return`
* `map_clone`
* `manual_range_contains`
* `match_like_matches_macro`
* `len_zero`
* `match_ref_pats`
* `mem_replace_with_default`
* `match_like_matches_macro`
* `needless_borrow`

* For `missing_safety_doc` and `empty_loop`, we have opened
  tracking issues for those (#808 and #810), as they will
  require additional more involved changes. a5bba8a
@kevinaboos kevinaboos added minor tracking an issue or PR used for tracking purposes only labels Jan 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
minor tracking an issue or PR used for tracking purposes only
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kevinaboos @amab8901