From 7895bd57b9c19de25c88c3a569f3bca710cabd3d Mon Sep 17 00:00:00 2001
From: Gyeongjae Choi <def6488@gmail.com>
Date: Sun, 27 Mar 2022 17:04:08 +0900
Subject: [PATCH] DOC Add deprecation timeline (#2314)

* Add deprecation timeline [skip ci]

* Add pyodide-interrupts removal
---
 docs/project/changelog.md            |  7 ++++++
 docs/project/deprecation-timeline.md | 32 ++++++++++++++++++++++++++++
 2 files changed, 39 insertions(+)
 create mode 100644 docs/project/deprecation-timeline.md

diff --git a/docs/project/changelog.md b/docs/project/changelog.md
index ddd3d6432..97c4b9dca 100644
--- a/docs/project/changelog.md
+++ b/docs/project/changelog.md
@@ -1005,3 +1005,10 @@ _Mar 21, 2019_
   have been removed.
 
 - The `run_docker` script can now be configured with environment variables.
+
+```{eval-rst}
+.. toctree::
+   :hidden:
+
+   deprecation-timeline.md
+```
diff --git a/docs/project/deprecation-timeline.md b/docs/project/deprecation-timeline.md
new file mode 100644
index 000000000..6dc908808
--- /dev/null
+++ b/docs/project/deprecation-timeline.md
@@ -0,0 +1,32 @@
+(deprecation-timeline)=
+
+# Pyodide Deprecation Timeline
+
+Each Pyodide release may deprecate certain features from previous releases in a backward incompatible way.
+If a feature is deprecated, it will continue to work until its removal, but raise warnings.
+We try to ensure deprecations are done over at least two minor(feature) releases,
+however, as Pyodide is still in beta state, this list is subject to change and
+some features can be removed without deprecation warnings.
+More details about each item can often be found in the {ref}`changelog`.
+
+## 0.21.0
+
+- The `globals` argument to `runPython` and `runPythonAsync` will be passed as a named argument only.
+
+## 0.20.0
+
+- The skip-host key will be removed from the meta.yaml format. If needed, install a host copy of the package with pip instead.
+- `pyodide-interrupts` module will be removed. If you were using this for some reason, use
+  {any}`setInterruptBuffer <pyodide.setInterruptBuffer>` instead.
+
+## 0.19.0
+
+- The default working directory (home directory) inside the Pyodide
+  virtual file system has been changed from `/` to `/home/pyodide`. To get the
+  previous behavior, you can
+
+  - call `os.chdir("/")` in Python to change working directory or
+  - call {any}`loadPyodide <globalThis.loadPyodide>` with the `homedir="/"`
+    argument
+
+- When a JavaScript function is called from Python, PyProxy arguments and return values will be automatically destroyed when the function is finished.