Skip to content

Rustdoc displays negative impls for traits identically to standard impls #21310

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
Closed
mkovalchik opened this issue Jan 17, 2015 · 7 comments · Fixed by #21342 or #23809
Closed

Rustdoc displays negative impls for traits identically to standard impls #21310

mkovalchik opened this issue Jan 17, 2015 · 7 comments · Fixed by #21342 or #23809
Assignees
@emberian
Labels
P-medium Medium priority T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Milestone
1.0

Comments

@mkovalchik
Copy link

When documenting negative impls for the Send and Sync traits (added by RFC 19) rustdoc currently displays the negative impls identically to positive impls.

As an example, there's currently no indication that the Send impl for MutexGuard is actually opting out of the Send trait rather than adding an implementation of it.
@kmcallister
Copy link
Contributor

Eek.

@kmcallister kmcallister added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. I-nominated labels Jan 17, 2015
@Diggsey Diggsey mentioned this issue Jan 18, 2015
Merged
alexcrichton added a commit to alexcrichton/rust that referenced this issue Jan 21, 2015
@alexcrichton
rollup merge of rust-lang#21342: Diggsey/issue-21310
5123f75 
Fixes rust-lang#21310
@sellibitze
Copy link
Contributor

It seems the issue has not been solved completely. On a trait's page that lists all its implementors, it's still wrong. Checkout http://doc.rust-lang.org/std/marker/trait.Send.html for example.

@steveklabnik steveklabnik reopened this Feb 8, 2015
@steveklabnik
Copy link
Member

@sellibitze you mentioned http://doc.rust-lang.org/std/rc/struct.Rc.html in IRC, but I'm clearly seeing !Send: http://doc.rust-lang.org/std/rc/struct.Rc.html

@steveklabnik
Copy link
Member

After further discussion, http://doc.rust-lang.org/std/marker/trait.Send.html is still not showing !.

@sellibitze
Copy link
Contributor

Maybe the right thing to do is to just not mention Rc on trait.Send at all. Either that, or adding a '!' in there.

@Diggsey
Copy link
Contributor

Diggsey commented Feb 9, 2015

Or add the "!", but show them in a separate section below.

@pnkfelix
Copy link
Member

1.0 polish, "P-veryhigh"

@pnkfelix pnkfelix added this to the 1.0 milestone Feb 12, 2015
@pnkfelix pnkfelix added P-medium Medium priority and removed I-nominated labels Feb 12, 2015
@emberian emberian self-assigned this Mar 26, 2015
@emberian emberian mentioned this issue Mar 28, 2015
Merged
bors added a commit that referenced this issue Mar 29, 2015
@bors
Auto merge of #23809 - cmr:issue-21310, r=Manishearth
ea03ad9 
This isn't really possible to test in an automatic way, since the only traits
you can negative impl are `Send` and `Sync`, and the implementors page for
those only exists in libstd.

Closes #21310
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@emberian emberian

Labels
P-medium Medium priority T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
1.0
7 participants
@steveklabnik @pnkfelix @sellibitze @kmcallister @Diggsey @emberian @mkovalchik