diff options
| author | Tim Radvan <tim@tjvr.org> | 2021-04-16 12:18:04 +0100 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2021-05-08 18:02:04 +1000 |
| commit | fd24e649fde26bcd484b30025527768d37f5c562 (patch) | |
| tree | 6f82e91eaca5e0d2330cddb6921b059688def801 /docs/library/machine.rst | |
| parent | 9eea51b730532cb33fe2531a3aade734d0a0a121 (diff) | |
| download | micropython-fd24e649fde26bcd484b30025527768d37f5c562.tar.gz micropython-fd24e649fde26bcd484b30025527768d37f5c562.zip | |
docs/library: Add initial API reference for rp2 module and its classes.
All the method signatures from rp2_pio.c and friends have been taken and
converted to RST format, then explanatory notes added for each signature.
Signed-off-by: Tim Radvan <tim@tjvr.org>
Diffstat (limited to 'docs/library/machine.rst')
| -rw-r--r-- | docs/library/machine.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/library/machine.rst b/docs/library/machine.rst index f831049f88..0a1c1c9530 100644 --- a/docs/library/machine.rst +++ b/docs/library/machine.rst @@ -64,9 +64,11 @@ Interrupt related functions Power related functions ----------------------- -.. function:: freq() +.. function:: freq([hz]) - Returns CPU frequency in hertz. + Returns the CPU frequency in hertz. + + On some ports this can also be used to set the CPU frequency by passing in *hz*. .. function:: idle() |