Documentation of C API? #16995
-
|
I'm interested in writing some .mpy libraries. I'm able to build the main examples in examples/natmod. But I was wondering if there's a good source of documentation for the C API? Something like a Micropython equivalent of https://docs.python.org/3/c-api/index.html? The page https://docs.micropython.org/en/latest/develop/publiccapi.html is just a stub. |
Beta Was this translation helpful? Give feedback.
Replies: 2 comments
-
There isn't. But you're not the first to ask this question and IIRC the response is always along the lines of: 'the code in those functions is clear enough to be the documentation, and within the py/ directory for instance there are enough usage examples to make any doubts clear'. I tend to agree: it is in fact a pretty clean codebase. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks. This is what I expected. Just wanted to check I wasn't missing some essential resource.
|
Beta Was this translation helpful? Give feedback.
There isn't. But you're not the first to ask this question and IIRC the response is always along the lines of: 'the code in those functions is clear enough to be the documentation, and within the py/ directory for instance there are enough usage examples to make any doubts clear'. I tend to agree: it is in fact a pretty clean codebase.