summaryrefslogtreecommitdiffstatshomepage
path: root/docs/library/pyb.rst
diff options
context:
space:
mode:
authorPeter Hinch <peter@hinch.me.uk>2016-01-11 06:48:35 +0000
committerDamien George <damien.p.george@gmail.com>2016-01-13 21:53:26 +0000
commitc13b2f2d0040cdf38ea3178717480d07f02c5245 (patch)
treea6d17950ffc505f19f565f7f0b8313dc2246cc60 /docs/library/pyb.rst
parent22d85ec5be77e7ee6b703221d51113f7f21a995b (diff)
downloadmicropython-c13b2f2d0040cdf38ea3178717480d07f02c5245.tar.gz
micropython-c13b2f2d0040cdf38ea3178717480d07f02c5245.zip
docs: Several minor changes: network, pyb, ADCAll and inline asm.
Diffstat (limited to 'docs/library/pyb.rst')
-rw-r--r--docs/library/pyb.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/library/pyb.rst b/docs/library/pyb.rst
index 546e7e5787..7be39a5d8e 100644
--- a/docs/library/pyb.rst
+++ b/docs/library/pyb.rst
@@ -25,6 +25,10 @@ Time related functions
after 2^30 milliseconds (about 12.4 days) this will start to return
negative numbers.
+ Note that if :meth:`pyb.stop()` is issued the hardware counter supporting this
+ function will pause for the duration of the "sleeping" state. This
+ will affect the outcome of :meth:`pyb.elapsed_millis()`.
+
.. function:: micros()
Returns the number of microseconds since the board was last reset.
@@ -33,6 +37,10 @@ Time related functions
after 2^30 microseconds (about 17.8 minutes) this will start to return
negative numbers.
+ Note that if :meth:`pyb.stop()` is issued the hardware counter supporting this
+ function will pause for the duration of the "sleeping" state. This
+ will affect the outcome of :meth:`pyb.elapsed_micros()`.
+
.. function:: elapsed_millis(start)
Returns the number of milliseconds which have elapsed since ``start``.