adjust warnings doc

This commit is contained in:
l1npengtul 2022-10-31 22:26:04 +09:00
parent ec332b4e49
commit 87e51cb8fe

View File

@ -25,7 +25,7 @@ static AHASH_SEED: OnceLock<Option<[u64; 4]>> = OnceLock::new();
/// This is a global variable, and thus will affect every Rhai instance. /// This is a global variable, and thus will affect every Rhai instance.
/// This should not be used _unless_ you know you need it. /// This should not be used _unless_ you know you need it.
/// ///
/// **WARNING**: /// # Warning:
/// - You can only call this function **ONCE** for the whole of your program execution. /// - You can only call this function **ONCE** for the whole of your program execution.
/// - You should gracefully handle the `Err(())`. /// - You should gracefully handle the `Err(())`.
/// - You **MUST** call this before **ANY** Rhai operation occurs (e.g. creating an [`Engine`]). /// - You **MUST** call this before **ANY** Rhai operation occurs (e.g. creating an [`Engine`]).