Skip to content

Commit

Permalink
[docgen] Update doc/telescope.txt
Browse files Browse the repository at this point in the history
skip-checks: true
  • Loading branch information
Github Actions committed Apr 5, 2024
1 parent 38c9f46 commit c7da09f
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions doc/telescope.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2561,7 +2561,7 @@ utils.path_expand({path}) *telescope.utils.path_expand()*
string


utils.transform_path({opts}, {path}) *telescope.utils.transform_path()*
utils.transform_path({opts}) *telescope.utils.transform_path()*
Transform path is a util function that formats a path based on path_display
found in `opts` or the default value from config. It is meant to be used in
make_entry to have a uniform interface for builtins as well as extensions
Expand All @@ -2571,9 +2571,8 @@ utils.transform_path({opts}, {path}) *telescope.utils.transform_path()*


Parameters: ~
{opts} (table) The opts the users passed into the picker. Might
contains a path_display key
{path} (string) The path that should be formatted
{opts} (table) The opts the users passed into the picker. Might
contains a path_display key

Return: ~
string: The transformed path ready to be displayed
Expand Down

0 comments on commit c7da09f

Please sign in to comment.