From c0cdd143132ecb0abe46c93106a39fbd55a8a494 Mon Sep 17 00:00:00 2001 From: AkiyukiOkayasu Date: Sun, 25 Feb 2024 23:37:15 +0900 Subject: [PATCH] Improve doc comment for set_voltage() function --- rp2040-hal/src/vreg.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/rp2040-hal/src/vreg.rs b/rp2040-hal/src/vreg.rs index 8d891292b..e28fab35b 100644 --- a/rp2040-hal/src/vreg.rs +++ b/rp2040-hal/src/vreg.rs @@ -14,7 +14,10 @@ use crate::pac::vreg_and_chip_reset::vreg::VSEL_A; use crate::pac::VREG_AND_CHIP_RESET; -/// Set voltage to the on-chip voltage regulator +/// Set voltage to the on-chip voltage regulator. +/// +/// There is no guarantee that the device will operate at all of the available voltages. +/// Appropriate values should be selected in consideration of the system clock frequency and other factors to be set. /// /// # Arguments ///