diff --git a/doc/telescope_changelog.txt b/doc/telescope_changelog.txt index 301ddbaf6e..5b255f7aee 100644 --- a/doc/telescope_changelog.txt +++ b/doc/telescope_changelog.txt @@ -8,8 +8,15 @@ Date: May 17, 2021 PR: https://github.com/nvim-telescope/telescope.nvim/pull/922 -A lot of new and breaking changes here as we work to clean up the way users -can configure how telescope's windows are configured. +This is one of our largest breaking changes thus far, so I (TJ) am adding some +information here so that you can more easily update (without having to track +down the commit, etc.). + +The goal of these breaking changes is to greatly simplify the way +configuration for layouts happen. This should make it much easier to configure +each picker, layout_strategy, and more. Please report any bugs or behavior +that is broken / confusing upstream and we can try and make the configuration +better. |telescope.setup()| has changed `layout_defaults` -> `layout_config`. This makes it so that the setup and the pickers share the same key, diff --git a/lua/telescope/config.lua b/lua/telescope/config.lua index 9f84de6366..aecfcc6e28 100644 --- a/lua/telescope/config.lua +++ b/lua/telescope/config.lua @@ -310,6 +310,7 @@ function config.set_defaults(user_defaults, tele_defaults) -- Check if using layout keywords outside of `layout_config` deprecated.picker_window_options(user_defaults) + -- Check if using `layout_defaults` instead of `layout_config` user_defaults = deprecated.layout_configuration(user_defaults)