Skip to content

rustdoc: Tracking issue for pointer and reference in intra-doc links #80896

New issue
New issue
Open
Open
rustdoc: Tracking issue for pointer and reference in intra-doc links#80896
Labels
A-intra-doc-linksArea: Intra-doc links, the ability to link to items in docs by nameC-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCS-tracking-needs-summaryStatus: It's hard to tell what's been done and what hasn't! Someone should do some investigation.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

Description

@camelid
camelid
opened on Jan 11, 2021

The feature gate for this experimental feature is intra_doc_pointers.

Note

Tracking issues are used to record the overall progress of implementation.
They are also used as hubs connecting to other relevant issues, e.g., bugs or open design questions.

A tracking issue is however not meant for large scale discussion, questions, or bug reports.
Instead, open a dedicated issue for the specific matter or post in the #t-rustdoc Zulip channel.

Discussion comments will get marked as off-topic or deleted.
Repeated discussions on the tracking issue may lead to the tracking issue getting locked.

Steps

  • Implementation PR
  • Stabilization PR

Implementation history

Historic notes

We may want to put other targets behind the feature gate too, but we at least
want to get pointer behind one before #80181 hits beta.

See the discussion on Zulip for more.

Activity

  1. camelid
    added
    A-intra-doc-linksArea: Intra-doc links, the ability to link to items in docs by name
    T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.
    on Jan 11, 2021
  2. camelid
    assigned
    jyn514
    on Jan 11, 2021
  3. jyn514
    changed the title [-]rustdoc: Put `pointer` intra-doc target behind a feature gate[/-] [+]rustdoc: tracking issue for `pointer` and `reference` in intra-doc links[/+] on Jan 14, 2021
  4. jyn514
    added
    C-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFC
    on Jan 14, 2021
  5. bors
    added a commit that references this issue on Jan 18, 2021

    Auto merge of rust-lang#81015 - jyn514:feature-gate-ptr, r=camelid

    66eb982

  6. jhpratt commented on Feb 19, 2021

    @jhpratt
    jhpratt
    on Feb 19, 2021
    Member

    Getting an error on nightly from this that originates in stdlib.

    Not sure if this needs special-casing, a feature gate added to core, or just the removal of the link. But something certainly isn't correct.

    error[E0658]: linking to associated items of raw pointers is experimental
  --> /home/jhpratt/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/src/rust/library/core/src/ptr/metadata.rs:51:23
   |
51 | /// [`to_raw_parts`]: *const::to_raw_parts
   |                       ^^^^^^^^^^^^^^^^^^^^
   |
   = note: see issue #80896 <https://github.com/rust-lang/rust/issues/80896> for more information
   = help: add `#![feature(intra_doc_pointers)]` to the crate attributes to enable
   = note: rustdoc does not allow disambiguating between `*const` and `*mut`, and pointers are unstable until it does

    This is the line that the error traces to.

  7. jhpratt commented on Feb 19, 2021

    @jhpratt
    jhpratt
    on Feb 19, 2021
    Member

    cc @jyn514 see above. It looks like you're the one that gated this.

  8. jhpratt commented on Feb 19, 2021

    @jhpratt
    jhpratt
    on Feb 19, 2021
    Member

    Looks like this was noticed before I commented. The issue for it is #82284.

  9. Manishearth
    added
    A-rustdoc
    and removed
    A-rustdoc
    on Apr 23, 2021

  10. Nemo157 commented on May 8, 2021

    @Nemo157
    Nemo157
    on May 8, 2021
    Contributor

    Given that #62834 allowed the applied type Vec<T> to link to the type constructor Vec, it feels like *const T/&T and similar syntax should also be supported to link to the pages for the type constructors pointer/reference.

  11. camelid commented on May 8, 2021

    @camelid
    camelid
    on May 8, 2021
    MemberAuthor

    Perhaps, but I imagine that linking to *const T is not that common, and if it's not that common then it doesn't seem that bad to have people use [*const T](pointer).

  12. jyn514
    removed their assignment
    on Feb 15, 2022
  13. bors
    added a commit that references this issue on Feb 28, 2023

    Auto merge of #14220 - lowr:fix/ci-pointer-offset-is-unstable, r=lnicola

    7f01ae8
  14. fmease
    changed the title [-]rustdoc: tracking issue for `pointer` and `reference` in intra-doc links[/-] [+]rustdoc: Tracking issue for `pointer` and `reference` in intra-doc links[/+] on Oct 10, 2025
  15. fmease
    added
    S-tracking-needs-summaryStatus: It's hard to tell what's been done and what hasn't! Someone should do some investigation.
    on Oct 10, 2025
  16. michielp1807
    added a commit that references this issue on Nov 10, 2025

    Remove doc links to `pointer::as_mut`

    8618189
  17. folkertdev
    added a commit that references this issue on Nov 11, 2025

    Remove doc links to `pointer::as_mut`

    c70084e
  18. michielp1807
    added a commit that references this issue on Nov 12, 2025

    Manually add doc links to `pointer::as_mut`

    ef74642
  19. moeyensj
    added a commit that references this issue on May 21, 2026

    v1.2.1: docs.rs build fix; cover update_nongrav_coeffs error path

    9964eec
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-intra-doc-linksArea: Intra-doc links, the ability to link to items in docs by nameC-tracking-issueCategory: An issue tracking the progress of sth. like the implementation of an RFCS-tracking-needs-summaryStatus: It's hard to tell what's been done and what hasn't! Someone should do some investigation.T-rustdocRelevant to the rustdoc team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions