[PATCH v2 05/12] c-user: Clarify object services documentation

Sebastian Huber sebastian.huber at embedded-brains.de
Wed Feb 10 16:28:02 UTC 2021


Unify the wording across similar directives of other managers.

Update #3993.
---
 c-user/object-services/directives.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/c-user/object-services/directives.rst b/c-user/object-services/directives.rst
index 19d4d82..54f234f 100644
--- a/c-user/object-services/directives.rst
+++ b/c-user/object-services/directives.rst
@@ -168,9 +168,9 @@ Gets the object name associated with the object identifier.
     This parameter is the object identifier to get the name.
 
 ``name``
-    This parameter is the pointer to an object name variable.  The object name
-    associated with the object identifier will be stored in this variable, in
-    case of a successful operation.
+    This parameter is the pointer to an object name variable.  When the
+    directive call is successful, the object name associated with the object
+    identifier will be stored in this variable.
 
 .. rubric:: RETURN VALUES:
 
@@ -801,9 +801,9 @@ Gets the object class information of the object class of the object API.
     information.
 
 ``info``
-    This parameter is the pointer to an object class information variable.  The
-    object class information of the class of the API will be stored in this
-    variable, in case of a successful operation.
+    This parameter is the pointer to an object class information variable.
+    When the directive call is successful, the object class information of the
+    class of the API will be stored in this variable.
 
 .. rubric:: RETURN VALUES:
 
-- 
2.26.2



More information about the devel mailing list