-
-
Notifications
You must be signed in to change notification settings - Fork 5.8k
Closed
Labels
Description
The following are suggested changes to the documentation file builtin.txt regarding returned values (apologies for the ragged formatting).
- cursor()
Documentation says returned value is Number but what that number represents is not documented.
Based on documentation in the source code, suggest adding this statement:
"Returns 0 when the position could be set, -1 otherwise."
- setcursorcharpos()
Same comments as for cursor().
Based on the source code, suggest adding this statement:
"Returns 0 when the position could be set, -1 otherwise."
- feedkeys()
Documentation states "Return value is always 0" but "Return type" is given as "String or list<string> depending on {list}".
At a minimum, the documentation is inconsistent.
Regarding "Return type", the function does not have a {list} argument.
Suspect that the Return type should be Number.
- finddir() & findfile()
In response to issue Improve documentation #17171, the documented return types for finddir() and findfile() were updated to include list<string>.
However, the help topic "builtin-function-list" should also have been updated but was not.
Suggestion: change "String" to "String or List" in that help topic.
- getreg()
Return type is documented as String but list<string> is also possible if the {list} argument is true.
Suggested corrections (not sure which would be correct):
Return type: String or list<string> depending on {list}.
or
Return type: String or list<any> depending on {list}.