docs: Add beginnings of troubleshooting doc. #220
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fixes micropython#172. Related to micropython#214.
willingc
reviewed
Sep 1, 2017
docs/troubleshooting.rst
Outdated
| @@ -0,0 +1,40 @@ | |||
| Troubleshooting | |||
| ============================== | |||
There was a problem hiding this comment.
With rst, the underlines should match the length of the text above.
docs/troubleshooting.rst
Outdated
| File system issues | ||
| ------------------------------ | ||
|
|
||
| If your host computer starts complaining that your CIRCUITPY drive is corrupted |
docs/troubleshooting.rst
Outdated
| before being reset by the button or being disconnected from USB. This can also | ||
| happen on Linux and Mac OSX but its less likely. | ||
|
|
||
| .. danger:: This will erase all your files in CIRCUITPY! |
There was a problem hiding this comment.
Perhaps:
.. caution:: Delete ``CIRCUITPY`` filesystem and reload CircuitPython.
To reload CircuitPython (for example, to correct a corrupted filesystem),
follow the process below. It's important to note that **any files stored on the
``CIRCUITPY`` drive will be erased**.
docs/troubleshooting.rst
Outdated
| #. After about 15 seconds, the NexoPixel will start flashing green. If it flashes red, the erase failed. | ||
| #. Double-click again and load the appropriate `CircuitPython .uf2 <https://github.com/adafruit/circuitpython/releases/latest>`_. | ||
|
|
||
| ValueError: Incompatible .mpy file. |
docs/troubleshooting.rst
Outdated
| ValueError: Incompatible .mpy file. | ||
| ------------------------------------- | ||
|
|
||
| This error occurs when importing a module that is stored as a `mpy` binary file |
docs/troubleshooting.rst
Outdated
| but, rarely they aren't. In particular, the `mpy` binary format changed between | ||
| CircuitPython versions 1.x and 2.x. | ||
|
|
||
| So, if you just upgraded to 2.x from 1.x you'll need to download a newer version |
docs/troubleshooting.rst
Outdated
| CircuitPython versions 1.x and 2.x. | ||
|
|
||
| So, if you just upgraded to 2.x from 1.x you'll need to download a newer version | ||
| of the library. They are all available in the |
There was a problem hiding this comment.
library Adafruit or Community bundle of libraries.
There was a problem hiding this comment.
I reworded this to make it clearer.
|
Thanks for the suggestions! |
|
I'm going to pull this now so I can get the link setup. I'll be happy to fix any further comments in a follow up. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #172. Related to #214.