You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Intralinks do not resolve re-exports. This means that if you have
mod foo {pubmod bar {structBar{}}}pubuse foo::bar;
you cannot have an intralink to crate::bar::Bar, because re-exports are not resolved by cargo-rdme.
This would be a reasonably acceptable limitation, if it wasn't a very common pattern in the standard library. For instance things defined in alloc are then re-exported in std, for instance, you cannot link to ::std::vec::Vec. This makes it a much more annoying limitation which deserves to be fixed.
Something that we need to support is crate imports with rename (again, a common pattern in the standard library). For instance, this is how std::vec comes to be:
externcrate alloc as alloc_crate;
⋮
pubuse alloc_crate::vec;
This is independent from supporting use re-exports.
The text was updated successfully, but these errors were encountered:
orium
changed the title
Intralinks to identifiers that are exported do not work (the standard library does this a lot)
Intralinks to identifiers that are re-exported do not work (the standard library does this a lot)
Feb 15, 2022
`cargo rdme` currently doesn't support re-exported types so modules that
define types that appear in the crate-level docs must be accessible.
See <orium/cargo-rdme#5>
MaxOhn
added a commit
to MaxOhn/rosu-mods
that referenced
this issue
Jul 4, 2024
`cargo rdme` currently doesn't support re-exported types so modules that
define types that appear in the crate-level docs must be accessible.
See orium/cargo-rdme#5
Intralinks do not resolve re-exports. This means that if you have
you cannot have an intralink to
crate::bar::Bar
, because re-exports are not resolved by cargo-rdme.This would be a reasonably acceptable limitation, if it wasn't a very common pattern in the standard library. For instance things defined in
alloc
are then re-exported instd
, for instance, you cannot link to::std::vec::Vec
. This makes it a much more annoying limitation which deserves to be fixed.Something that we need to support is crate imports with rename (again, a common pattern in the standard library). For instance, this is how
std::vec
comes to be:This is independent from supporting
use
re-exports.The text was updated successfully, but these errors were encountered: