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

Report module reexports in rustdoc #3537

Closed
brson opened this issue Sep 19, 2012 · 5 comments
Closed

Report module reexports in rustdoc #3537

brson opened this issue Sep 19, 2012 · 5 comments
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

@brson
Copy link
Contributor

brson commented Sep 19, 2012

rustdoc lost this ability, presumably with the resolve rewrite. I want to do it differently next time: for each module add another section that lists reexports and links to their original definition.

@brson
Copy link
Contributor Author

brson commented Oct 19, 2012

Discovering reexports requires running resolve to completion, and that requires loading the already compiled binaries of all dependencies, which is not the place of a documentation tool.

Perhaps they can be annotated manually.

@graydon
Copy link
Contributor

graydon commented May 1, 2013

If a crate saved its reexports in metadata tables, would this be sufficient?

@graydon
Copy link
Contributor

graydon commented May 1, 2013

(nominating for feature-complete)

@brson
Copy link
Contributor Author

brson commented May 1, 2013

@graydon It would not be necessary. Rustdoc can't figure out reexports because it can't depend on having access to compiled crates. To read the metadata out of the crates, the crates would need to be precompiled before running rustdoc, but if that were the case then rustdoc wouldn't have this problem anyway because it could just run resolve.

@graydon
Copy link
Contributor

graydon commented May 9, 2013

dupe of / continued in #5486

@graydon graydon closed this as completed May 9, 2013
RalfJung pushed a commit to RalfJung/rust that referenced this issue May 4, 2024
RalfJung pushed a commit to RalfJung/rust that referenced this issue May 4, 2024
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

2 participants