465d84b7e7
docs/library: Add CPython docs xref to each pertinent module.
...
Cross-reference text/link is implemented as RST substitution, so easy to
consistently.
2017-07-02 15:37:31 +03:00
6f87b03e3c
docs/utime: Use markup adhering to the latest conventions.
2017-06-25 00:54:38 +03:00
ca16c38210
various: Spelling fixes
2017-05-29 11:36:05 +03:00
3acace588a
docs/utime: Deconditionalize description of sleep().
2017-04-09 00:42:32 +03:00
0a861db91c
docs/utime: De-conditionalize description of sleep_ms() and friends.
...
These are basic MicroPython API, and all ports should implement them.
2017-04-05 11:40:47 +03:00
9b80a1e3e9
utime module documentation fixes and cleanup:
...
* Fix mis-spelling of `ticks_add` in code examples.
* Be consistent about parentheses after function names.
* Be consistent about formatting of function, variable and constant names.
* Be consistent about spaces and punctuation.
* Fix some language errors (missing or wrong words, wrong word order).
* Keep line length under 90 chars.
Signed-off-by: Christopher Arndt <chris@chrisarndt.de>
2017-03-17 20:45:08 +03:00
805f7ea2f2
docs/utime: Add docs for ticks_add(), improvements for other ticks_*().
2016-11-01 00:14:12 +03:00
8679d9e6a6
docs/utime: Remove only:: for ticks_diff().
...
It's mandatory function which should be present in every port. Even if
it's not, in the stdlib intro we waarn users that a particular port can
lack anything of described in the docs.
2016-11-01 00:03:40 +03:00
d60ad5cf53
docs/utime: Describe new semantics of ticks_diff() (signed ring arithmetics).
2016-10-31 00:17:56 +03:00
153665f159
docs/utime: Document ticks_cpu() in more detail.
...
Also, drop ::only directive.
2016-10-30 23:15:28 +03:00
ce166e6b68
docs: Spelling mistakes
2016-08-02 11:17:46 +03:00
83e99f88cb
docs/utime: Clarify module purpose.
2016-05-01 01:48:30 +03:00
613fd0a1ca
docs/library/utime: Elaborate on epochs and calendar time maintenance.
2016-05-01 00:16:47 +03:00
df4e1d1279
docs/library: Consistently use admonitions for CPython differences.
2016-04-27 15:43:48 +03:00
31300b5144
docs/utime: Describe sleep() peculiarities in MicroPython.
...
Not all ports accept floating-point value.
2016-04-27 15:28:46 +03:00
c564169c8f
docs/utime: Describe time() peculiarities in MicroPython.
2016-04-27 15:23:11 +03:00
556e5dfd35
docs/library/utime: Add more time functions for unix and esp8266 ports.
2016-04-27 12:30:59 +01:00
e0f7e001e8
docs: Fix uos and utime heading underlines to be the correct length.
...
Otherwise Sphinx gives a warning.
2016-04-27 12:11:27 +01:00
678f3a1e05
docs: Module "time" is actually "utime".
2016-04-27 01:38:59 +03:00
Paul Sokolovsky
Ville Skyttä
Christopher Arndt
Mike Causer
Damien George