Fix docs.

This commit is contained in:
Stephen Chung 2022-11-11 16:46:28 +08:00
parent 6708d59e3f
commit 0984f2d4df
4 changed files with 8 additions and 8 deletions

View File

@ -2,7 +2,7 @@
//!
//! Set to [`None`] to disable stable hashing.
//!
//! See [`set_rhai_ahash_seed`].
//! See [`rhai::config::hashing::set_ahash_seed`][set_ahash_seed].
//!
//! # Example
//!
@ -189,7 +189,7 @@ static AHASH_SEED: SusLock<Option<[u64; 4]>> = SusLock::new();
/// # Warning
///
/// * You can only call this function **ONCE** for the entire duration of program execution.
/// * You **MUST** call this before performing **ANY** Rhai operation (e.g. creating an [`Engine`]).
/// * You **MUST** call this before performing **ANY** Rhai operation (e.g. creating an [`Engine`][crate::Engine]).
///
/// # Error
///
@ -216,7 +216,7 @@ pub fn set_ahash_seed(new_seed: Option<[u64; 4]>) -> Result<(), Option<[u64; 4]>
///
/// Otherwise, the hashing seed is randomized to protect against DOS attacks.
///
/// See [`set_rhai_ahash_seed`] for more.
/// See [`rhai::config::hashing::set_ahash_seed`][set_ahash_seed] for more.
#[inline]
#[must_use]
pub fn get_ahash_seed() -> &'static Option<[u64; 4]> {

View File

@ -100,7 +100,7 @@ pub struct NativeCallContextStore {
#[cfg(feature = "internals")]
#[allow(deprecated)]
impl NativeCallContextStore {
/// Create a [`NativeCallContext`] from a [`NativeCallContextClone`].
/// Create a [`NativeCallContext`] from a [`NativeCallContextStore`].
///
/// # WARNING - Unstable API
///
@ -167,7 +167,7 @@ impl<'a> NativeCallContext<'a> {
}
}
/// _(internals)_ Create a [`NativeCallContext`] from a [`NativeCallContextClone`].
/// _(internals)_ Create a [`NativeCallContext`] from a [`NativeCallContextStore`].
/// Exported under the `internals` feature only.
///
/// # WARNING - Unstable API
@ -187,7 +187,7 @@ impl<'a> NativeCallContext<'a> {
pos: context.pos,
}
}
/// _(internals)_ Store this [`NativeCallContext`] into a [`NativeCallContextClone`].
/// _(internals)_ Store this [`NativeCallContext`] into a [`NativeCallContextStore`].
/// Exported under the `internals` feature only.
///
/// # WARNING - Unstable API

View File

@ -6,7 +6,7 @@ use crate::{
use std::prelude::v1::*;
use std::{ops::AddAssign, slice::Iter};
/// [Module] resolution service that holds a collection of module resolvers,
/// [Module][crate::Module] resolution service that holds a collection of module resolvers,
/// to be searched in sequential order.
///
/// # Example

View File

@ -2,7 +2,7 @@ use crate::{Engine, ModuleResolver, Position, RhaiResultOf, SharedModule, ERR};
#[cfg(feature = "no_std")]
use std::prelude::v1::*;
/// Empty/disabled [module][Module] resolution service that acts as a dummy.
/// Empty/disabled [module][crate::Module] resolution service that acts as a dummy.
///
/// # Example
///