summaryrefslogtreecommitdiffstatshomepage
path: root/docs/reference/index.rst
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2017-07-01 22:09:40 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2017-07-01 22:09:40 +0300
commit8b7d31159506d1708c18704f4c8bda69dddcfdb8 (patch)
tree4f5f4c6f0a20db06f4c480396b8a46af4849803c /docs/reference/index.rst
parent50eea2614510b87031fed60bdab40e5b878fef70 (diff)
downloadmicropython-8b7d31159506d1708c18704f4c8bda69dddcfdb8.tar.gz
micropython-8b7d31159506d1708c18704f4c8bda69dddcfdb8.zip
reference/index: Rewrite introduction paragraph to avoid confusion.
The old intro talked about "differences", but there were hardly any sections describing differences, mostly MicroPython specific features. On the other hand, we now have real "differences" chapter, though it's mostly concerned with stdlib differences. So, try to avoid confusion by changing wording and linking to the other chapters and contrasting them with what is described in "MicroPython language".
Diffstat (limited to 'docs/reference/index.rst')
-rw-r--r--docs/reference/index.rst19
1 files changed, 13 insertions, 6 deletions
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
index 7a85fc5cf3..63d9941b1f 100644
--- a/docs/reference/index.rst
+++ b/docs/reference/index.rst
@@ -1,13 +1,20 @@
The MicroPython language
========================
-MicroPython aims to implement the Python 3.4 standard, and most of
-the features of MicroPython are identical to those described by the
-documentation at
-`docs.python.org <https://docs.python.org/3.4/reference/index.html>`_.
+MicroPython aims to implement the Python 3.4 standard (with selected
+features from later versions) with respect to language syntax, and most
+of the features of MicroPython are identical to those described by the
+"Language Reference" documentation at
+`docs.python.org <https://docs.python.org/3/reference/index.html>`_.
-Differences to standard Python as well as additional features of
-MicroPython are described in the sections here.
+The MicroPython standard library is described in the
+:ref:`corresponding chapter <micropython_lib>`. The :ref:`cpython_diffs`
+chapter describes differences between MicroPython and CPython (which
+mostly concern standard library and types, but also some language-level
+features).
+
+This chapter describes features and peculiarities of MicroPython
+implementation and the best practices to use them.
.. toctree::
:maxdepth: 1