diff options
| author | Bruno Haible <bruno@clisp.org> | 2020-02-02 13:31:11 +0100 |
|---|---|---|
| committer | Bruno Haible <bruno@clisp.org> | 2020-02-02 13:31:11 +0100 |
| commit | bb931010f3fedc6ab155384bfbef77a282117f88 (patch) | |
| tree | 9224362c75a83e60e14ced3c95c7eae3eee2208c /lib/gl_map.h | |
| parent | 6a5df5fb005c8a41a2020538532563ad54998128 (diff) | |
| download | gnulib-bb931010f3fedc6ab155384bfbef77a282117f88.tar.gz | |
list, set, oset, map, omap: Avoid imperative voice in documentation.
* lib/gl_map.h: Use descriptive sentences instead of imperative voice
in the specification of functions.
* lib/gl_omap.h: Likewise.
Diffstat (limited to 'lib/gl_map.h')
| -rw-r--r-- | lib/gl_map.h | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/lib/gl_map.h b/lib/gl_map.h index 8b45c839c0..8a203b6270 100644 --- a/lib/gl_map.h +++ b/lib/gl_map.h @@ -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. */ |