Skip to content

Ensure all safety comments quote and cite a specific version of the documentation #1655

@joshlf

Description

@joshlf

All safety comments should be of the following form:

// SAFETY: The alignment cannot be greater than the size [1].
//
// [1] Per https://doc.rust-lang.org/1.81.0/reference/type-layout.html#size-and-alignment:
//
//   The size of a value is always a multiple of its alignment.

Note in particular:

  • Cites a specific version of the documentation (in this case 1.81.0)
  • Cites a stable version of the documentation (rather than nightly or beta)
  • Quotes the relevant part of the citation

This issue tracks getting all existing safety comments up to this standard.

Mentoring instructions

Interested in contributing? See our contributing guide.

Find any comment that doesn't follow this standard and update it!

Metadata

Metadata

Assignees

No one assigned

    Labels

    experience-easyThis issue is easy, and shouldn't require much experiencehelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions