Skip to content

Commit f4b60a2

Browse files
committed
fix(docs): replace unresolvable intra-doc links with code spans
Replace private-item intra-doc links that fail `cargo doc -D warnings` with equivalent code spans or inline prose: - `src/resolve/ffi_bridge/mod.rs`: replace `[`FfiAbi::consumers`]` in the module doc with inline prose and add an explicit link target for `[`FfiAbi`]` to resolve the remaining reference correctly. - `src/symbol/descriptor.rs`: replace `[is_simple_ident_char]` (private fn, not re-exported) with a code span so the doc compiles cleanly.
1 parent 54919b4 commit f4b60a2

2 files changed

Lines changed: 4 additions & 3 deletions

File tree

src/resolve/ffi_bridge/mod.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
//! `#[no_mangle]` function is callable from C under a stable linker name, and a
77
//! PyO3 `#[pyfunction]` is callable from Python. The extractor records each as a
88
//! neutral [`FfiExport`] fact (tagged with its [`FfiAbi`]); this resolver bridges
9-
//! it to call sites in a language that **consumes that ABI**
10-
//! ([`FfiAbi::consumers`]) — so a C call binds to a C-ABI export, a Python call
9+
//! it to call sites in a language that **consumes that ABI** (the ABI's consumer
10+
//! set) — so a C call binds to a C-ABI export, a Python call
1111
//! to a Python-ABI export, never crossed.
1212
//!
1313
//! It is the honest, deterministic subset of cross-language linking: the export
@@ -29,6 +29,7 @@
2929
//! [`Confidence::NameOnly`]: crate::graph::Confidence::NameOnly
3030
//! [`Provenance::FfiBridge`]: crate::graph::Provenance::FfiBridge
3131
//! [`FfiExport`]: crate::graph::FfiExport
32+
//! [`FfiAbi`]: crate::graph::FfiAbi
3233
3334
mod resolver;
3435

src/symbol/descriptor.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ pub enum Descriptor {
3131
Term(String),
3232
/// A method or free function (`ident(disambiguator).`). The `disambiguator`
3333
/// distinguishes overloads and **must** be a SCIP *simple-identifier* (chars
34-
/// per [`is_simple_ident_char`]) or empty: SCIP's grammar is
34+
/// per `is_simple_ident_char`) or empty: SCIP's grammar is
3535
/// `method-disambiguator ::= simple-identifier?` with **no escaped form**, so
3636
/// a non-simple disambiguator cannot be rendered to a parseable SCIP string.
3737
/// Empty disambiguator is the common case.

0 commit comments

Comments
 (0)