Improve doc comment for set_voltage() function

rp-rs · Feb 25, 2024 · c0cdd14 · c0cdd14
1 parent 6263bfc
commit c0cdd14
Showing 1 changed file with 4 additions and 1 deletion.
diff --git 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
 ///