From 73648125546dc1c6b6b88dc1190b3be5d3975a33 Mon Sep 17 00:00:00 2001 From: Arijit Basu Date: Sat, 11 Dec 2021 21:40:28 +0530 Subject: [PATCH] Add upgrade guide --- docs/en/src/upgrade-guide.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/en/src/upgrade-guide.md b/docs/en/src/upgrade-guide.md index 6631332..1a054ce 100644 --- a/docs/en/src/upgrade-guide.md +++ b/docs/en/src/upgrade-guide.md @@ -45,6 +45,20 @@ compatibility. ### Instructions +#### [v0.16.4][44] -> [v0.17.0][45] + +- Deprecated `app.directory_buffer`, `app.history`, and `app.last_modes` in + the custom dynamic layout renderer context. + As of now, there's no way to access these fields in dynamic layouts. While + `app.history` and `app.last_modes` can be re-added upon request + (with justification), `app.directory_buffer` has been deprecated for good. + However, there's no change in the `CallLua*` context. +- Set `xplr.config.general.help_hide_remaps` to `true` to hide the remaps in + help menu. +- `None` will be serialized to `nil` in Lua. +- `LuaEval` can now return a function that will be called with the Lua Context + argument. Refer to the `Full List of Messages` doc for example. + #### [v0.15.2][43] -> [v0.16.4][44] - Deprecated `config.general.cursor`. The default terminal cursor will be used @@ -300,3 +314,4 @@ Else do the following: [42]: https://github.com/sayanarijit/xplr/releases/tag/v0.14.4 [43]: https://github.com/sayanarijit/xplr/releases/tag/v0.15.2 [44]: https://github.com/sayanarijit/xplr/releases/tag/v0.16.4 +[45]: https://github.com/sayanarijit/xplr/releases/tag/v0.17.0