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 should copy docs from interfaces to implementation methods #1678

Closed
brson opened this issue Jan 26, 2012 · 6 comments
Closed

rustdoc should copy docs from interfaces to implementation methods #1678

brson opened this issue Jan 26, 2012 · 6 comments
Labels
E-hard Call for participation: Hard difficulty. Experience needed to fix: A lot. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@brson
Copy link
Contributor

brson commented Jan 26, 2012

Undocumented methods should have their docs copied from the interface documentation. This will be difficult for interfaces in the same crate, and very difficult for interfaces in external crates.

@graydon
Copy link
Contributor

graydon commented Jun 6, 2013

Nominating for feature completeness.

@brson
Copy link
Contributor Author

brson commented Jun 6, 2013

Could also not specify the methods on trait impls, and just link back to the trait.

@graydon
Copy link
Contributor

graydon commented Jun 6, 2013

accepted for feature-complete milestone

@msullivan
Copy link
Contributor

No change, I think. Part of #5413

@emberian
Copy link
Member

#8125

Fixed by rustdoc_ng

/cc @Seldaek

@emberian
Copy link
Member

Now that rustdoc_ng has been merged, closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E-hard Call for participation: Hard difficulty. Experience needed to fix: A lot. 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

4 participants