DOC Update docs for iodide code removal #981
Conversation
Relevant iodide PR to minimize breakage: iodide-project/iodide#3015
There was a problem hiding this comment.
There is a few more occurrences;
docs/index.rst
26:Pyodide may be used in several ways, including in an Iodide notebook, directly
35: using_pyodide_from_iodide.md
docs/type_conversions.md
8: (evaluating a Python cell in Iodide)
docs/loading_packages.md
60:For use in Iodide:
Ideally we should find a way to deploy docs on readthedocs for v0.16.1 that would not be overwritten by latest development changes, so that iodide users would still have docs to refer to. We would need to get manainer's right on the RDT project for this though.
Edit: though linking to the docs on github as you did in iodide is also probably fine
docs/changelog.md
Outdated
| *Unreleased* | ||
|
|
||
| - Removed iodide-specific code in `pyodide.js`. This breaks compatibility with | ||
| iodide and other users pretending to be iodide. |
There was a problem hiding this comment.
I think
| iodide and other users pretending to be iodide. | |
| iodide. |
would be fine. Could we maybe add a badge "Breaking change" in the beginning as in https://scikit-learn.org/stable/whats_new/v0.24.html ?
|
I don't know how to do badges, but I made a breaking changes section
like 0.16.0
|
rth
changed the title
| ### Breaking changes | ||
|
|
||
| - Removed iodide-specific code in `pyodide.js`. This breaks compatibility with | ||
| iodide. |
There was a problem hiding this comment.
For future PRs, it's also helpful to include a link to the PR in the changelog entries. (I'll fix this one in #987)
Relevant iodide PR to minimize breakage: iodide-project/iodide#3015