RTD documentation updates#863
Conversation
tannewt
left a comment
tannewt
left a comment
There was a problem hiding this comment.
Thanks for updating this! I'm a stickler on a number of these core modules and would like to mark them unsupported until we restructure their docs and make sure they match CPython's use.
| - tracks MicroPython's releases (not master). | ||
| - Longints (arbitrary-length integers) are turned on for most Express builds | ||
| (those boards with SPI flash chips external to the microcontroller), | ||
| but not for boards without SPI flash, for space reasons. |
There was a problem hiding this comment.
We'll have express stuff in M4 non-express right? Should we target 256kb binary size for them? I think thats what I have setup now.
There was a problem hiding this comment.
Right, didn't think of M4-non-Express.
| @@ -1,8 +1,6 @@ | |||
| :mod:`array` -- arrays of numeric data | |||
| ====================================== | |||
|
|
|||
There was a problem hiding this comment.
I'd prefer to have these docs inline rather than in files separate from the implementation. Until then I'd like to call them unsupported because its hard to keep them up to date.
There was a problem hiding this comment.
I'm reluctant to call them unsupported. To me that means you shouldn't use them, or that we wouldn't fix bugs in them. If you want to say that they may change in the future, that seems more like what you want to imply. But we couldn't write a lot of useful code without struct, array, sys, os, etc. in our libraries and use them in Learn Guides, so maybe something milder than "unsupported".
| :class: attention | ||
|
|
||
| This function is MicroPython extension. | ||
| This function is a MicroPython extension. |
There was a problem hiding this comment.
Lets not call gc supported until we move the extensions out of here.
There was a problem hiding this comment.
"The functionality of gc may change in the future to more closely match that of CPython."
|
I didn't restore the word "unsupported", but I added some stronger caveats about using the MicroPython-derived libraries. See if this matches your intent. |
tannewt
left a comment
tannewt
left a comment
There was a problem hiding this comment.
The new warning is great! Thanks!
tannewt
left a comment
tannewt
left a comment
There was a problem hiding this comment.
The build is failing because struct.rst is duplicating shared-bindings/struct. Should be as easy as removing struct.rst.
2 participants
This is meant to address the documentation shortcomings in #328. There's more work that could be done on the documentation, but I'm trying to bring it somewhat more up to date.
More work needs to be done after renaming more builtin modules to drop the "u" prefix.