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

Url pointing to invalid methods in documentation of pointer type #50746

Closed
pravic opened this issue May 14, 2018 · 3 comments
Closed

Url pointing to invalid methods in documentation of pointer type #50746

pravic opened this issue May 14, 2018 · 3 comments
Assignees
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@pravic
Copy link
Contributor

pravic commented May 14, 2018

https://doc.rust-lang.org/std/primitive.pointer.html
https://doc.rust-lang.org/nightly/std/primitive.pointer.html

It turns out that the pointer type is implemented twice: for impl<T> *const T and impl<T> *mut T. However, the index section contains links to the first implementation only, whereas methods from the second implementation have different href anchors:

For example, links from the index:
https://doc.rust-lang.org/nightly/std/primitive.pointer.html#method.is_null
https://doc.rust-lang.org/nightly/std/primitive.pointer.html#method.is_null

And actual anchors:
https://doc.rust-lang.org/nightly/std/primitive.pointer.html#method.is_null
https://doc.rust-lang.org/nightly/std/primitive.pointer.html#method.is_null-1

The same in stable version.

cc @steveklabnik (I don't know the name of the docs team, unfortunately)
cc @GuillaumeGomez probably

Possibly related to #24558.

@steveklabnik steveklabnik added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. T-dev-tools-rustdoc labels May 14, 2018
@GuillaumeGomez
Copy link
Member

GuillaumeGomez commented May 14, 2018

And is it bad? It clearly states impl for *const T and impl for *mut T after all...

@pravic
Copy link
Contributor Author

pravic commented May 14, 2018

The second is_null (and other methods) in index (on the left, below Methods) still points to the first implementation. That's wrong.

@GuillaumeGomez
Copy link
Member

Oh I see! Yes, it's an issue.

@GuillaumeGomez GuillaumeGomez self-assigned this Jul 12, 2018
@XAMPPRocky XAMPPRocky added the C-enhancement Category: An issue proposing an enhancement or a PR with one. label Oct 2, 2018
@GuillaumeGomez GuillaumeGomez changed the title Duplicated methods in documentation of pointer type Url pointing to invalid methods in documentation of pointer type Oct 30, 2018
bors added a commit that referenced this issue Dec 4, 2018
…uietMisdreavus

Fixes primitive sidebar link generation

Fixes #50746.
Fixes #55656.

r? @QuietMisdreavus
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: An issue proposing an enhancement or a PR with one. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

5 participants