feat!: allow full height, width by resolving 1 as a percentage rather than absolute val (#2525)

this is technically a breaking change but i doubt anyone uses height/width 1 (absolute value). It makes more sense to treat 1 as 100%
This commit is contained in:
Simon Hauser
2023-05-24 12:27:19 +02:00
committed by GitHub
parent 80eefd8ff0
commit 066bda8ea4
2 changed files with 18 additions and 18 deletions

View File

@@ -2160,14 +2160,14 @@ Provides "resolver functions" to allow more customisable inputs for options.
resolver.resolve_height() *telescope.resolve.resolve_height()*
Converts input to a function that returns the height. The input must take
one of five forms:
1. 0 <= number < 1
1. 0 <= number <= 1
This means total height as a percentage.
2. 1 <= number
2. 1 < number
This means total height as a fixed number.
3. function
Must have signature: function(self, max_columns, max_lines): number
4. table of the form: { val, max = ..., min = ... }
val has to be in the first form 0 <= val < 1 and only one is given,
val has to be in the first form 0 <= val <= 1 and only one is given,
`min` or `max` as fixed number
5. table of the form: {padding = `foo`}
where `foo` has one of the previous three forms.
@@ -2183,14 +2183,14 @@ resolver.resolve_height() *telescope.resolve.resolve_height()*
resolver.resolve_width() *telescope.resolve.resolve_width()*
Converts input to a function that returns the width. The input must take
one of five forms:
1. 0 <= number < 1
1. 0 <= number <= 1
This means total width as a percentage.
2. 1 <= number
2. 1 < number
This means total width as a fixed number.
3. function
Must have signature: function(self, max_columns, max_lines): number
4. table of the form: { val, max = ..., min = ... }
val has to be in the first form 0 <= val < 1 and only one is given,
val has to be in the first form 0 <= val <= 1 and only one is given,
`min` or `max` as fixed number
5. table of the form: {padding = `foo`}
where `foo` has one of the previous three forms.