Add help documentation and docstrings #29
Conversation
docs/ml_get_event_certainty.md
Outdated
| ``` | ||
|
|
||
| ```package | ||
| machine-learning=github:microbit-foundation/pxt-microbit-ml |
There was a problem hiding this comment.
Not sure whether this should in some way be versioned? Might be awkward or something we can revisit after getting this documentation out.
There was a problem hiding this comment.
This is awkward. This can be versioned, and probably should be versioned. However, what version should it reference. Ideally a future version that we haven't tagged yet, otherwise it's always slightly out of sync.
We might have to merge changes as they are, tag, commit a change to set this to the most recently tagged version, then tag again?
Scenarios where versioning is important:
If we remove a block, it's example or signature will no longer render in the help docs for older versions of the extension.
There was a problem hiding this comment.
Target most recently tagged version for now 69336c5. There haven't been any relevant block changes since this tag so this should be safe.
There was a problem hiding this comment.
We discussed that ideally this would be templated and happen during "pxt bump" but not clear there's a mechanism to do this. One to revisit when we need to tag a version that doesn't exist!
Co-authored-by: Matt Hillsdon <[email protected]>
No description provided.