Commit 11011fb
committed
docs(contract): link items in doc comments instead of naming them
Matches the style already used elsewhere in the crate ([`WORST_CASE_ENTRY_BYTES`],
[`VerificationResult::Verified`]): a bracketed link reads as a reference to an item
rather than as decoration.
No rot detection, despite broken_intra_doc_links being denied at the workspace level
and check-docs running with RUSTDOCFLAGS=-D warnings. near-sdk refuses to build this
crate outside wasm32, so cargo doc cannot document it and the workspace run skips it
entirely -- verified by inserting a link to a method that does not exist and watching
cargo doc --workspace exit 0. The three paths here were checked by hand instead.
Converted the references that name items: Self::get_tee_accounts, Self::config, and
crate::MpcContract::submit_participant_info. Parameter names stay in plain backticks,
and attestation_storage_fee_millinear stays plain too -- it is read by an operator out
of config() JSON, and the field is pub(crate).1 parent 9375044 commit 11011fb
3 files changed
Lines changed: 4 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
775 | 775 | | |
776 | 776 | | |
777 | 777 | | |
778 | | - | |
| 778 | + | |
779 | 779 | | |
780 | 780 | | |
781 | 781 | | |
| |||
907 | 907 | | |
908 | 908 | | |
909 | 909 | | |
910 | | - | |
| 910 | + | |
911 | 911 | | |
912 | 912 | | |
913 | 913 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
475 | 475 | | |
476 | 476 | | |
477 | 477 | | |
478 | | - | |
| 478 | + | |
479 | 479 | | |
480 | 480 | | |
481 | 481 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
409 | 409 | | |
410 | 410 | | |
411 | 411 | | |
412 | | - | |
| 412 | + | |
413 | 413 | | |
414 | 414 | | |
415 | 415 | | |
| |||
0 commit comments