Cross-crate links are not always present

[EthanYuan]

Reporting two examples of missing cross-crate links related to re-exports.

example 1

I noticed that in the documentation for the Script struct in the ckb-jsonrpc-types crate (Script), the H256 type is mentioned. However, the H256 type is not linked to its corresponding documentation page in the ckb-fixed-hash-core crate (H256).

Additional Information:

• Both of these crates are included in the ckb workspace. When running cargo doc --workspace --no-deps --open from the local ckb path, the correct link for the H256 type can be generated.
• The H256 type is originally defined in ckb-fixed-hash-core.
• H256 is re-exported in ckb-fixed-hash (which depends on ckb-fixed-hash-core).
• H256 is re-exported again in ckb-types (which depends on ckb-fixed-hash).
• The problematic crate ckb-jsonrpc-types depends on H256 from ckb-types.

---

example 2

In the documentation for the ChainStore trait in the ckb-store crate (ChainStore), the DBPinnableSlice type and DBIter type are mentioned in required methods get and get_iter. However, the types are not linked to its corresponding documentation pages in the ckb-rocksdb crate (DBPinnableSlice and DBIterator).

Additional Information:

• When running cargo doc --workspace --open from the local ckb path, the correct link for the DBPinnableSlice type and DBIter type can be generated. However, running cargo doc --workspace --no-deps --open produces the same result as described in the issue (i.e., no links are generated).
• The DBPinnableSlice type and DBIter type are originally defined in ckb-rocksdb.
• The DBPinnableSlice type and DBIter type are re-exported in ckb-db (which depends on ckb-rocksdb).
• The problematic crate ckb-store depends on DBPinnableSlice and DBIter from ckb-db.

[Nemo157]

Likely to be #1588, cargo doesn't correctly handle transitive dependencies currently.

[EthanYuan]

Likely to be #1588, cargo doesn't correctly handle transitive dependencies currently.

Thank you for providing more information about transitive dependencies.

I tried the method of explicitly declaring the path below, and the result of using cargo doc locally is that it only serves as a workaround for the annotated documentation, but it doesn't affect the hyperlinks for types in the code.

pub struct Script {
    /// The hash [`H256`] used to match the script code.
    /// 
    /// [`H256`]: https://docs.rs/ckb-fixed-hash-core/0.111.0-rc8/ckb_fixed_hash_core/struct.H256.html
    pub code_hash: H256,
    /// Specifies how to use the `code_hash` to match the script code.
    pub hash_type: ScriptHashType,
    /// Arguments for script.
    pub args: JsonBytes,
}

I look forward to docs.rs being able to address this issue in the near future, to align with the local documentation generation (which is currently working fine).

[Nemo157]

Since a few nightlies ago this has been fixed (rust-lang/cargo#13481), I queued a rebuild of the latest version and https://docs.rs/ckb-jsonrpc-types/0.114.0/ckb_jsonrpc_types/struct.Script.html now includes a link to H256 in the Fields section too.

[syphar]

@Nemo157 so this issue can be closed?