6f87b03e3c
docs/utime: Use markup adhering to the latest conventions.
7 years ago
ca16c38210
various: Spelling fixes
8 years ago
3acace588a
docs/utime: Deconditionalize description of sleep().
8 years ago
0a861db91c
docs/utime: De-conditionalize description of sleep_ms() and friends.
These are basic MicroPython API, and all ports should implement them.
8 years ago
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>
8 years ago
805f7ea2f2
docs/utime: Add docs for ticks_add(), improvements for other ticks_*().
8 years ago
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.
8 years ago
d60ad5cf53
docs/utime: Describe new semantics of ticks_diff() (signed ring arithmetics).
8 years ago
153665f159
docs/utime: Document ticks_cpu() in more detail.
Also, drop ::only directive.
8 years ago
ce166e6b68
docs: Spelling mistakes
8 years ago
83e99f88cb
docs/utime: Clarify module purpose.
9 years ago
613fd0a1ca
docs/library/utime: Elaborate on epochs and calendar time maintenance.
9 years ago
df4e1d1279
docs/library: Consistently use admonitions for CPython differences.
9 years ago
31300b5144
docs/utime: Describe sleep() peculiarities in MicroPython.
Not all ports accept floating-point value.
9 years ago
c564169c8f
docs/utime: Describe time() peculiarities in MicroPython.
9 years ago
556e5dfd35
docs/library/utime: Add more time functions for unix and esp8266 ports.
9 years ago
e0f7e001e8
docs: Fix uos and utime heading underlines to be the correct length.
Otherwise Sphinx gives a warning.
9 years ago
678f3a1e05
docs: Module "time" is actually "utime".
9 years ago
67f40fb237
docs: Include extra functions in time documentation for pyboard.
9 years ago
4542643025
docs: Update all WiPy docs to reflect the new API.
9 years ago
5161239c9f
cc3200: time.sleep() now receives seconds, like CPython.
9 years ago
cfcf47c064
docs: Add initial draft documentation for the WiPy.
This makes all common files "port-aware" using the .. only directive.
10 years ago
a58713a899
docs: Cleanup and update some docs.
10 years ago
88d3054ac0
docs: Import documentation from source-code inline comments.
The inline docs (prefixed with /// in .c files) have been converted to
RST format and put in the docs subdirectory.
10 years ago
Paul Sokolovsky
Ville Skyttä
Christopher Arndt
Mike Causer
Damien George
Henrik Sölver
danicampora