Improve documentation

greenbone · Nov 26, 2020 · f930e4d · f930e4d
1 parent 2582f62
commit f930e4d
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/gvm/protocols/gmpv214/gmpv214.py b/gvm/protocols/gmpv214/gmpv214.py
@@ -406,8 +406,8 @@ def modify_user(
     ) -> Any:
 
         """Modifies an existing user. Most of the fields need to be supplied
-        for changing a single field even if no change is wanted.
-        Else empty values are places instead.
+        for changing a single field even if no change is wanted for those.
+        Else empty values are inserted for the missing fields instead.
 
         Arguments:
             user_id: UUID of the user to be modified.

diff --git a/gvm/protocols/gmpv7/gmpv7.py b/gvm/protocols/gmpv7/gmpv7.py
@@ -6080,7 +6080,9 @@ def modify_user(
         ifaces_allow: Optional[bool] = False,
         group_ids: Optional[List[str]] = None,
     ) -> Any:
-        """Modifies an existing user.
+        """Modifies an existing user. Most of the fields need to be supplied
+        for changing a single field even if no change is wanted for those.
+        Else empty values are inserted for the missing fields instead.
 
         Arguments:
             user_id: UUID of the user to be modified. Overrides name element