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

rustdoc: Does not list impls on type aliases #44182

Closed
sdroege opened this issue Aug 30, 2017 · 4 comments
Closed

rustdoc: Does not list impls on type aliases #44182

sdroege opened this issue Aug 30, 2017 · 4 comments
Labels
C-bug Category: This is a bug. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@sdroege
Copy link
Contributor

sdroege commented Aug 30, 2017

Happens with https://github.com/sdroege/gstreamer-rs/tree/52c013b8348ab3a98bb8475916aa306a3fc664de

If you check gstreamer/src/caps.rs, it has impl Caps, where type Caps = GstRc<CapsRef>. That one shows up in the rustdoc index (when searching), but neither on the Caps type alias docs, nor on the GstRc docs.

In gstreamer/src/buffer.rs there is impl GstRc<BufferRef>. That one shows up in the GstRc docs.

@GuillaumeGomez

sdroege added a commit to sdroege/gstreamer-rs that referenced this issue Aug 30, 2017
@shepmaster shepmaster added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. C-bug Category: This is a bug. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. labels Sep 1, 2017
@QuietMisdreavus
Copy link
Member

That commit (nor the current master) does not contain an impl Caps block for rustdoc to pick up. It does have an impl GstRc<CapsRef>, which, when changed to impl Caps will properly show up on the Caps page, thanks to #42027. It does, however remove it from the GstRc page. If this is desired, this has been fixed. Otherwise it can be folded into #32077 since it would require more active work of substituting the full type when searching for impls.

@sdroege
Copy link
Contributor Author

sdroege commented Oct 9, 2017

Having it only the the Caps page would be good enough for my taste. If it's on the GstRc page, there will be a lot of noise and it will be hard to find anything :)

@QuietMisdreavus
Copy link
Member

Then I'll call this "fixed by #42027". 😀 If you change the impl blocks to point to the type alias instead of the expanded type, then render docs with a nightly compiler, the docs will show up the way you want them.

@sdroege
Copy link
Contributor Author

sdroege commented Oct 9, 2017

Perfect, thanks :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Category: This is a bug. T-dev-tools Relevant to the dev-tools subteam, which will review and decide on the PR/issue. 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

3 participants