Skip to content

Commit 8b7d311

Browse files
committed
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".
1 parent 50eea26 commit 8b7d311

File tree

3 files changed

+17
-6
lines changed

3 files changed

+17
-6
lines changed

docs/differences/index_template.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _cpython_diffs:
2+
13
MicroPython differences from CPython
24
====================================
35

docs/library/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _micropython_lib:
2+
13
MicroPython libraries
24
=====================
35

docs/reference/index.rst

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
11
The MicroPython language
22
========================
33

4-
MicroPython aims to implement the Python 3.4 standard, and most of
5-
the features of MicroPython are identical to those described by the
6-
documentation at
7-
`docs.python.org <https://docs.python.org/3.4/reference/index.html>`_.
4+
MicroPython aims to implement the Python 3.4 standard (with selected
5+
features from later versions) with respect to language syntax, and most
6+
of the features of MicroPython are identical to those described by the
7+
"Language Reference" documentation at
8+
`docs.python.org <https://docs.python.org/3/reference/index.html>`_.
89

9-
Differences to standard Python as well as additional features of
10-
MicroPython are described in the sections here.
10+
The MicroPython standard library is described in the
11+
:ref:`corresponding chapter <micropython_lib>`. The :ref:`cpython_diffs`
12+
chapter describes differences between MicroPython and CPython (which
13+
mostly concern standard library and types, but also some language-level
14+
features).
15+
16+
This chapter describes features and peculiarities of MicroPython
17+
implementation and the best practices to use them.
1118

1219
.. toctree::
1320
:maxdepth: 1

0 commit comments

Comments
 (0)