]> Savannah Git Hosting - gnulib.git/commitdiff
list, set, oset, map, omap: Avoid imperative voice in documentation.
authorBruno Haible <bruno@clisp.org>
Sun, 2 Feb 2020 12:31:11 +0000 (13:31 +0100)
committerBruno Haible <bruno@clisp.org>
Sun, 2 Feb 2020 12:31:11 +0000 (13:31 +0100)
* lib/gl_map.h: Use descriptive sentences instead of imperative voice
in the specification of functions.
* lib/gl_omap.h: Likewise.

lib/gl_map.h
lib/gl_omap.h

index 8b45c839c0811e2b2df013b55b00eee62b2cf8ee..8a203b6270a972d39aa2dc2667a474746f30b57f 100644 (file)
@@ -172,7 +172,7 @@ extern int gl_map_nx_getput (gl_map_t map, const void *key, const void *value,
    Returns false otherwise.  */
 extern bool gl_map_remove (gl_map_t map, const void *key);
 
-/* Removes a pair from a map and retrieve the previous value.
+/* Removes a pair from a map and retrieves the previous value.
    Returns true and sets *OLDVALUEP to the previous value, if the key was found
    and its pair removed.
    Returns false otherwise.  */
index afb4411495e15b6ff5fdec0302b384e50a18ba7c..c534db5826737b2eb636355818c4ad84be92f24d 100644 (file)
@@ -161,7 +161,7 @@ extern int gl_omap_nx_put (gl_omap_t map, const void *key, const void *value)
 #endif
   ;
 
-/* Adds a pair to an ordered map and retrieve the previous value.
+/* Adds a pair to an ordered map and retrieves the previous value.
    Returns true if a pair with the given key was not already in the map and so
    this pair was added.
    Returns false and sets *OLDVALUEP to the previous value, if a pair with the
@@ -182,7 +182,7 @@ extern int gl_omap_nx_getput (gl_omap_t map, const void *key, const void *value,
    Returns false otherwise.  */
 extern bool gl_omap_remove (gl_omap_t map, const void *key);
 
-/* Removes a pair from an ordered map and retrieve the previous value.
+/* Removes a pair from an ordered map and retrieves the previous value.
    Returns true and sets *OLDVALUEP to the previous value, if the key was found
    and its pair removed.
    Returns false otherwise.  */