8000 Style tweaks based on @willingc's feedback. · sparkfun/circuitpython@7932df0 · GitHub
[go: up one dir, main page]

Skip to content

Commit 7932df0

Browse files
committed
Style tweaks based on @willingc's feedback.
1 parent 544f5c3 commit 7932df0

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

docs/troubleshooting.rst

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,25 @@
11
Troubleshooting
2-
==============================
2+
===============
33

44
From time to time, an error occurs when working with CircuitPython. Here are a
55
variety of errors that can happen, what they mean and how to fix them.
66

77
File system issues
8-
------------------------------
8+
------------------
99

10-
If your host computer starts complaining that your CIRCUITPY drive is corrupted
10+
If your host computer starts complaining that your ``CIRCUITPY`` drive is corrupted
1111
or files cannot be overwritten or deleted, then you will have to erase it completely.
12-
When CircuitPython restarts it will create a fresh empty CIRCUITPY filesystem.
12+
When CircuitPython restarts it will create a fresh empty ``CIRCUITPY`` filesystem.
1313

14-
This often happens on Windows when the CIRCUITPY disk is not safely ejected
14+
This often happens on Windows when the ``CIRCUITPY`` disk is not safely ejected
1515
before being reset by the button or being disconnected from USB. This can also
1616
happen on Linux and Mac OSX but its less likely.
1717

18-
.. danger:: This will erase all your files in CIRCUITPY!
18+
.. caution:: Delete ``CIRCUITPY`` filesystem and reload CircuitPython.
19+
20+
To reload CircuitPython (for example, to correct a corrupted filesystem),
21+
follow the process below. It's important to note that **any files stored on the
22+
``CIRCUITPY`` drive will be erased**.
1923

2024
#. Download the appropriate flash erase uf2 from `here <https://github.com/adafruit/Adafruit_SPIFlash/tree/master/examples/flash_erase_express>`_.
2125
#. Double-click the reset button.
@@ -24,17 +28,18 @@ happen on Linux and Mac OSX but its less likely.
2428
#. After about 15 seconds, the NexoPixel will start flashing green. If it flashes red, the erase failed.
2529
#. Double-click again and load the appropriate `CircuitPython .uf2 <https://github.com/adafruit/circuitpython/releases/latest>`_.
2630

27-
ValueError: Incompatible .mpy file.
28-
-------------------------------------
31+
ValueError: Incompatible ``.mpy`` file.
32+
---------------------------------------
2933

30-
This error occurs when importing a module that is stored as a `mpy` binary file
31-
(rather than a `py` text file) that was generated by a different version of
34+
This error occurs when importing a module that is stored as a ``mpy`` binary file
35+
(rather than a ``py`` text file) that was generated by a different version of
3236
CircuitPython than the one its being loaded into. Most versions are compatible
33-
but, rarely they aren't. In particular, the `mpy` binary format changed between
37+
but, rarely they aren't. In particular, the ``mpy`` binary format changed between
3438
CircuitPython versions 1.x and 2.x.
3539

36-
So, if you just upgraded to 2.x from 1.x you'll need to download a newer version
37-
of the library. They are all available in the
40+
So, if you just upgraded to CircuitPython 2.x from 1.x you'll need to download a
41+
newer version of the library that triggered the error on ``import``. They are
42+
all available in the
3843
`Adafruit bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/latest>`_
3944
and the `Community bundle <https://github.com/adafruit/CircuitPython_Community_Bundle/releases/latest>`_.
4045
Make sure to download a version with 2.0.0 or higher in the filename.

0 commit comments

Comments
 (0)
0