docs: fix Picker:get_row(index) doc string (#1515)

This commit is contained in:
Martin Roa Villescas
2021-11-30 21:27:20 +01:00
committed by GitHub
parent ce8c8d4a45
commit ef245548a8

View File

@@ -159,10 +159,10 @@ function Picker:new(opts)
return obj return obj
end end
--- Take a row and get an index. --- Take an index and get a row.
---@note: Rows are 0-indexed, and `index` is 1 indexed (table index) ---@note: Rows are 0-indexed, and `index` is 1 indexed (table index)
---@param index number: The row being displayed ---@param index number: The index in line_manager
---@return number The row for the picker to display in ---@return number: The row for the picker to display in
function Picker:get_row(index) function Picker:get_row(index)
if self.sorting_strategy == "ascending" then if self.sorting_strategy == "ascending" then
return index - 1 return index - 1
@@ -174,7 +174,7 @@ end
--- Take a row and get an index --- Take a row and get an index
---@note: Rows are 0-indexed, and `index` is 1 indexed (table index) ---@note: Rows are 0-indexed, and `index` is 1 indexed (table index)
---@param row number: The row being displayed ---@param row number: The row being displayed
---@return number The index in line_manager ---@return number: The index in line_manager
function Picker:get_index(row) function Picker:get_index(row)
if self.sorting_strategy == "ascending" then if self.sorting_strategy == "ascending" then
return row + 1 return row + 1