Skip to content

Misleading documentation in std::option module #64844

Closed
Closed
Misleading documentation in std::option module#64844
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-bugCategory: This is a bug.

Description

@jfrimmel
jfrimmel
opened on Sep 27, 2019

The current std::option module states, that

Rust's pointer types must always point to a valid location; there are no "null" pointers.

Which is obviously wrong. There are no null references (&T), but there may be raw null pointers (*const T).
Maybe the docs should have used the terminology of smart pointers, which would be less misleading and be correct 😄

Activity

  1. jonas-schievink
    added
    C-bugCategory: This is a bug.
    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
    on Sep 27, 2019

  2. steveklabnik commented on Sep 28, 2019

    @steveklabnik
    steveklabnik
    on Sep 28, 2019
    Contributor

    I'd accept a PR to change "pointer" to "reference" here.

  3. hman523
    added a commit that references this issue on Sep 30, 2019

    Fixed a misleading documentation issue rust-lang#64844

    6c6d27d
  4. tmandry
    added a commit that references this issue on Sep 30, 2019

    Rollup merge of rust-lang#64911 - hman523:64844, r=Dylan-DPC

    2a6f495
  5. tmandry
    added a commit that references this issue on Sep 30, 2019

    Rollup merge of rust-lang#64911 - hman523:64844, r=Dylan-DPC

    5560f8c

  6. srinivasreddy commented on Nov 11, 2019

    @srinivasreddy
    srinivasreddy
    on Nov 11, 2019
    Contributor

    I think we can close this.

  7. steveklabnik
    closed this as completedon Nov 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-bugCategory: This is a bug.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions