diff options
author | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2017-06-28 00:37:47 +0300 |
---|---|---|
committer | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2017-06-28 00:37:47 +0300 |
commit | f8ac28964d8d7801baed71e6414aad8621471458 (patch) | |
tree | dfa7203211e0b93c669b0c69638759ee655d605e /docs/library/uos.rst | |
parent | 3e82bedf46c29ce33baa34cfeb535bf1a04e12f6 (diff) | |
download | micropython-f8ac28964d8d7801baed71e6414aad8621471458.tar.gz micropython-f8ac28964d8d7801baed71e6414aad8621471458.zip |
docs/{micropython,sys,uos}: Use markup adhering to the latest docs conventions.
Diffstat (limited to 'docs/library/uos.rst')
-rw-r--r-- | docs/library/uos.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/library/uos.rst b/docs/library/uos.rst index 3d0aa46c70..1e7f33161a 100644 --- a/docs/library/uos.rst +++ b/docs/library/uos.rst @@ -22,15 +22,15 @@ Functions This function returns an iterator which then yields 3-tuples corresponding to the entries in the directory that it is listing. With no argument it lists the - current directory, otherwise it lists the directory given by `dir`. + current directory, otherwise it lists the directory given by *dir*. - The 3-tuples have the form `(name, type, inode)`: + The 3-tuples have the form *(name, type, inode)*: - - `name` is a string (or bytes if `dir` is a bytes object) and is the name of + - *name* is a string (or bytes if *dir* is a bytes object) and is the name of the entry; - - `type` is an integer that specifies the type of the entry, with 0x4000 for + - *type* is an integer that specifies the type of the entry, with 0x4000 for directories and 0x8000 for regular files; - - `inode` is an integer corresponding to the inode of the file, and may be 0 + - *inode* is an integer corresponding to the inode of the file, and may be 0 for filesystems that don't have such a notion. .. function:: listdir([dir]) @@ -90,5 +90,5 @@ Functions .. function:: dupterm(stream_object) Duplicate or switch MicroPython terminal (the REPL) on the passed stream-like - object. The given object must implement the `.readinto()` and `.write()` + object. The given object must implement the ``readinto()`` and ``write()`` methods. If ``None`` is passed, previously set redirection is cancelled. |