rustdoc src links link to the wrong place for modules #12926
Labels
T-rustdoc
Relevant to the rustdoc team, which will review and decide on the PR/issue.
Comments
bors
added a commit
that referenced
this issue
Apr 28, 2014
This PR is primarily motivated by (and fixes) #12926. We currently only have a span for the individual item itself and not for the referred contents. This normally does not cause a problem since both are located in the same file; it *is* possible that the contained statement or item is located in the other file (the syntax extension can do that), but even in that case the syntax extension should be located in the same file as the item. The module item (i.e. `mod foo;`) is the only exception here, and thus warrants a special treatment. Rustdoc would now distinguish `mod foo;` from `mod foo {...}` by checking if the span for the module item and module contents is in different files. If it's the case, we'd prefer module contents over module item. There are alternative strategies, but as noted above we will have some corner cases if we don't record the contents span explicitly.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The source link for Any links to the module declaration in lib.rs instead of the more useful file, any.rs.
The text was updated successfully, but these errors were encountered: