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.

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

make rustdoc handle imports and exports #1391

Closed
boggle opened this issue Dec 28, 2011 · 2 comments
Closed

make rustdoc handle imports and exports #1391

boggle opened this issue Dec 28, 2011 · 2 comments
Assignees
@brson
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Milestone
0.2 release, deta...

Comments

@boggle
Copy link
Contributor

boggle commented Dec 28, 2011

rustdoc should copy docs from imported symbols. this would, for example, help float get docs from f32/f64.

Probably this should wait/ties in with copying default docs from interfaces when typeclasses become available.
@ghost ghost assigned brson Jan 17, 2012
@brson
Copy link
Contributor

brson commented Jan 26, 2012

This is going to require some heavy refactoring of the resolve pass. Right now the only way to get at this information is to run all of resolve, which will fail if all the dependencies aren't built and locatable. Requiring a build just to extract docs seems like a bad situation.

I also opened another issue for copying interface docs to implementations (#1678) because that will be harder still.

@brson
Copy link
Contributor

brson commented Mar 10, 2012

Done.

@brson brson closed this as completed Mar 10, 2012
bjorn3 added a commit to bjorn3/rust that referenced this issue Aug 9, 2023
@bjorn3
Use CARGO_ENCODED_RUSTFLAGS to support paths with spaces
68f7b82 
Fixes rust-lang#1391
Kobzol pushed a commit to Kobzol/rust that referenced this issue Dec 30, 2024
@tshepang
remove outdated info on debugging
b540fcf 
Closes rust-lang#1391

Also, do some small fixes/improvements while at it.
bors pushed a commit to rust-lang-ci/rust that referenced this issue Jan 2, 2025
@tshepang
remove outdated info on debugging
76af867 
Closes rust-lang#1391

Also, do some small fixes/improvements while at it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@brson brson

Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
0.2 release, detail work, cleanup and...
Development

No branches or pull requests
2 participants
@boggle @brson