Skip to content

Commit 2b3bc2e

Browse files
committed
fix: doc warnings
1 parent 4e5be47 commit 2b3bc2e

9 files changed

Lines changed: 9 additions & 9 deletions

File tree

fvm/src/account_actor.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
//! ## Future direction
77
//!
88
//! This coupling between the FVM and a concrete actor must eventually be
9-
//! eliminated. Refer to https://github.com/filecoin-project/fvm/issues/229 for
9+
//! eliminated. Refer to <https://github.com/filecoin-project/fvm/issues/229> for
1010
//! details.
1111
1212
use fvm_ipld_encoding::tuple::*;

fvm/src/gas/timer.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ struct GasTimerInner {
6565
impl GasTimer {
6666
/// Convenience method to start measuring time before the charge is made.
6767
///
68-
/// Use the return value with [GasTimer::finish_with] to override the internal
68+
/// Use the return value with [GasTimer::stop_with] to override the internal
6969
/// instant that the timer was started with.
7070
pub fn start() -> GasInstant {
7171
GasInstant::now()

fvm/src/syscalls/error.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ pub enum Abort {
2222
OutOfGas,
2323
/// The system failed with a fatal error indicating a bug in the FVM. This will abort the entire
2424
/// top-level message and record a
25-
/// [`SYS_ASSERTION_FAILED`][fvm_shared::ExitCode::SYS_ASSERTION_FAILED] exit code on-chain.
25+
/// [`SYS_ASSERTION_FAILED`][fvm_shared::error::ExitCode::SYS_ASSERTION_FAILED] exit code on-chain.
2626
#[error("fatal error: {0}")]
2727
Fatal(anyhow::Error),
2828
}

ipld/amt/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
//! AMT crate for use as rust IPLD data structure
66
//!
77
//! Data structure reference:
8-
//! https://github.com/ipld/specs/blob/51fab05b4fe4930d3d851d50cc1e5f1a02092deb/data-structures/vector.md
8+
//! <https://github.com/ipld/specs/blob/51fab05b4fe4930d3d851d50cc1e5f1a02092deb/data-structures/vector.md>
99
1010
mod amt;
1111
mod diff;

ipld/bitfield/src/rleplus/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
//! # RLE+ Bitset Encoding
66
//!
7-
//! (from https://github.com/filecoin-project/specs/blob/master/src/listings/data_structures.md)
7+
//! (from <https://github.com/filecoin-project/specs/blob/master/src/listings/data_structures.md>)
88
//!
99
//! RLE+ is a lossless compression format based on [RLE](https://en.wikipedia.org/wiki/Run-length_encoding).
1010
//! Its primary goal is to reduce the size in the case of many individual bits, where RLE breaks down quickly,

sdk/src/message.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ pub fn gas_premium() -> TokenAmount {
5757
MESSAGE_CONTEXT.gas_premium.into()
5858
}
5959

60-
/// Returns the message parameters as an Option<IpldBlock>.
60+
/// Returns the message parameters as an [`Option<IpldBlock>`].
6161
pub fn params_raw(id: BlockId) -> SyscallResult<Option<IpldBlock>> {
6262
if id == NO_DATA_BLOCK_ID {
6363
return Ok(None);

sdk/src/sys/actor.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ super::fvm_syscalls! {
9898
///
9999
/// # Arguments
100100
///
101-
/// - `typ` specifies the builtin-actor [`Type`] to lookup.
101+
/// - `typ` specifies the builtin-actor to lookup.
102102
/// - `obuf_off` and `obuf_len` specify the location and length of a byte buffer into which the
103103
/// FVM will write the s code CID.
104104
///

sdk/src/sys/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
//!
2121
//! ## Kind 1: Divergent
2222
//!
23-
//! Syscalls that return `!` (e.g. [`vm::abort`]) have the signature:
23+
//! Syscalls that return `!` (e.g. [`crate::vm::abort`]) have the signature:
2424
//!
2525
//! ```wat
2626
//! (func $name (param ...) ... (result i32))

shared/src/sys/out.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
//! plagued with issues and catch-22 problems, making it unfeasible to use
88
//! actual bare multi-value returns in FFI extern definitions.
99
//!
10-
//! Read more at https://github.com/rust-lang/rust/issues/73755.
10+
//! Read more at <https://github.com/rust-lang/rust/issues/73755>.
1111
1212
// NOTE: When possible, pack fields such that loads will be power-of-two aligned. Un-aligned loads
1313
// _can_ be done (LLVM will generate the appropriate code) but are slower.

0 commit comments

Comments
 (0)