Merge #24295 from justinmk/doc2

docs: "Return (multiple)", condense @notes

1 files changed, 37 insertions, 41 deletions

diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index 46c5f2ea18..d96169066c 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -727,8 +727,8 @@ nvim_del_keymap({mode}, {lhs})                             *nvim_del_keymap()*
 nvim_del_mark({name})                                        *nvim_del_mark()*
     Deletes an uppercase/file named mark. See |mark-motions|.
 
-    Note:
-        fails with error if a lowercase or buffer local named mark is used.
+    Note: ~
+      • Lowercase name (or other buffer-local mark) is an error.
 
     Parameters: ~
       • {name}  Mark name
@@ -952,6 +952,10 @@ nvim_get_current_win()                                *nvim_get_current_win()*
 nvim_get_hl({ns_id}, {*opts})                                  *nvim_get_hl()*
     Gets all or specific highlight groups in a namespace.
 
+    Note: ~
+      • When the `link` attribute is defined in the highlight definition map,
+        other attributes will not be taking effect (see |:hi-link|).
+
     Parameters: ~
       • {ns_id}  Get highlight groups for namespace ns_id
                  |nvim_get_namespaces()|. Use 0 to get global highlight groups
@@ -967,10 +971,6 @@ nvim_get_hl({ns_id}, {*opts})                                  *nvim_get_hl()*
         map as in |nvim_set_hl()|, or only a single highlight definition map
         if requested by name or id.
 
-    Note:
-        When the `link` attribute is defined in the highlight definition map,
-        other attributes will not be taking effect (see |:hi-link|).
-
 nvim_get_hl_id_by_name({name})                      *nvim_get_hl_id_by_name()*
     Gets a highlight group by name
 
@@ -987,13 +987,14 @@ nvim_get_keymap({mode})                                    *nvim_get_keymap()*
         "buffer" key is always zero.
 
 nvim_get_mark({name}, {opts})                                *nvim_get_mark()*
-    Return a tuple (row, col, buffer, buffername) representing the position of
-    the uppercase/file named mark. See |mark-motions|.
+    Returns a `(row, col, buffer, buffername)` tuple representing the position
+    of the uppercase/file named mark. "End of line" column position is
+    returned as |v:maxcol| (big number). See |mark-motions|.
 
     Marks are (1,0)-indexed. |api-indexing|
 
-    Note:
-        fails with error if a lowercase or buffer local named mark is used.
+    Note: ~
+      • Lowercase name (or other buffer-local mark) is an error.
 
     Parameters: ~
       • {name}  Mark name
@@ -1074,12 +1075,10 @@ nvim_input({keys})                                              *nvim_input()*
 
     On execution error: does not fail, but updates v:errmsg.
 
-    Note:
-        |keycodes| like <CR> are translated, so "<" is special. To input a
+    Note: ~
+      • |keycodes| like <CR> are translated, so "<" is special. To input a
         literal "<", send <LT>.
-
-    Note:
-        For mouse events use |nvim_input_mouse()|. The pseudokey form
+      • For mouse events use |nvim_input_mouse()|. The pseudokey form
         "<LeftMouse><col,row>" is deprecated since |api-level| 6.
 
     Attributes: ~
@@ -1099,8 +1098,8 @@ nvim_input_mouse({button}, {action}, {modifier}, {grid}, {row}, {col})
     Non-blocking: does not wait on any result, but queues the event to be
     processed soon by the event loop.
 
-    Note:
-        Currently this doesn't support "scripting" multiple mouse events by
+    Note: ~
+      • Currently this doesn't support "scripting" multiple mouse events by
         calling it multiple times in a loop: the intermediate mouse positions
         will be ignored. It should be used to implement real-time mouse input
         in a GUI. The deprecated pseudokey form ("<LeftMouse><col,row>") of
@@ -1316,8 +1315,8 @@ nvim_set_client_info({name}, {version}, {type}, {methods}, {attributes})
     appropriate. Example: library first identifies the channel, then a plugin
     using that library later identifies itself.
 
-    Note:
-        "Something is better than nothing". You don't need to include all the
+    Note: ~
+      • "Something is better than nothing". You don't need to include all the
         fields.
 
     Attributes: ~
@@ -1409,21 +1408,17 @@ nvim_set_current_win({window})                        *nvim_set_current_win()*
 nvim_set_hl({ns_id}, {name}, {*val})                           *nvim_set_hl()*
     Sets a highlight group.
 
-    Note:
-        Unlike the `:highlight` command which can update a highlight group,
-        this function completely replaces the definition. For example:
+    Note: ~
+      • Unlike the `:highlight` command which can update a highlight group, this
+        function completely replaces the definition. For example:
         `nvim_set_hl(0, 'Visual', {})` will clear the highlight group
         'Visual'.
-
-    Note:
-        The fg and bg keys also accept the string values `"fg"` or `"bg"`
-        which act as aliases to the corresponding foreground and background
-        values of the Normal group. If the Normal group has not been defined,
-        using these values results in an error.
-
-    Note:
-        If `link` is used in combination with other attributes; only the
-        `link` will take effect (see |:hi-link|).
+      • The fg and bg keys also accept the string values `"fg"` or `"bg"` which
+        act as aliases to the corresponding foreground and background values
+        of the Normal group. If the Normal group has not been defined, using
+        these values results in an error.
+      • If `link` is used in combination with other attributes; only the `link`
+        will take effect (see |:hi-link|).
 
     Parameters: ~
       • {ns_id}  Namespace id for this highlight |nvim_create_namespace()|.
@@ -2140,8 +2135,8 @@ nvim_buf_del_keymap({buffer}, {mode}, {lhs})           *nvim_buf_del_keymap()*
 nvim_buf_del_mark({buffer}, {name})                      *nvim_buf_del_mark()*
     Deletes a named mark in the buffer. See |mark-motions|.
 
-    Note:
-        only deletes marks set in the buffer, if the mark is not set in the
+    Note: ~
+      • only deletes marks set in the buffer, if the mark is not set in the
         buffer it will return false.
 
     Parameters: ~
@@ -2232,7 +2227,8 @@ nvim_buf_get_lines({buffer}, {start}, {end}, {strict_indexing})
         Array of lines, or empty array for unloaded buffer.
 
 nvim_buf_get_mark({buffer}, {name})                      *nvim_buf_get_mark()*
-    Returns a tuple (row,col) representing the position of the named mark. See
+    Returns a `(row,col)` tuple representing the position of the named mark.
+    "End of line" column position is returned as |v:maxcol| (big number). See
     |mark-motions|.
 
     Marks are (1,0)-indexed. |api-indexing|
@@ -2323,8 +2319,8 @@ nvim_buf_is_loaded({buffer})                            *nvim_buf_is_loaded()*
 nvim_buf_is_valid({buffer})                              *nvim_buf_is_valid()*
     Checks if a buffer is valid.
 
-    Note:
-        Even if a buffer is valid it may have been unloaded. See |api-buffer|
+    Note: ~
+      • Even if a buffer is valid it may have been unloaded. See |api-buffer|
         for more info about unloaded buffers.
 
     Parameters: ~
@@ -2386,8 +2382,8 @@ nvim_buf_set_mark({buffer}, {name}, {line}, {col}, {opts})
 
     Marks are (1,0)-indexed. |api-indexing|
 
-    Note:
-        Passing 0 as line deletes the mark
+    Note: ~
+      • Passing 0 as line deletes the mark
 
     Parameters: ~
       • {buffer}  Buffer to set the mark on
@@ -3442,8 +3438,8 @@ nvim_ui_attach({width}, {height}, {options})                *nvim_ui_attach()*
     Implies that the client is ready to show the UI. Adds the client to the
     list of UIs. |nvim_list_uis()|
 
-    Note:
-        If multiple UI clients are attached, the global screen dimensions
+    Note: ~
+      • If multiple UI clients are attached, the global screen dimensions
         degrade to the smallest client. E.g. if client A requests 80x40 but
         client B requests 200x100, the global screen has size 80x40.