API-Test.md

@@ -11,14 +11,14 @@ Defines maximum length for a Readingname (MAXLEN\_RN) and for a Device name (MAX
 - **goodDeviceName** (positional)
 - **goodReadingName** (positional)
 
-         = goodReadingName();
+        $valid = goodReadingName($name);
 
-    This function checks if Readingname  is a valid format which
+    This function checks if Readingname $name is a valid format which
     means up to MAXLEN:RN and consisting of any UTF-8 character except
 
-    - whitespace (\s)
+    - whitespace (\\s)
 
-    If the identifier starts with a dot , it's considered to be an
+    If the identifier starts with a dot `.`, it's considered to be an
     internal identifier and is treated differently in visualization,
     i.e. hidden. The leading . is not included in MAXLEN\_RN length
     considerations.
@@ -30,8 +30,8 @@ Defines maximum length for a Readingname (MAXLEN\_RN) and for a Device name (MAX
 - **makeDeviceName** (positional)
 - **makeReadingName** (positional)
 
-     = makeReadingName();
-    This function removes from given Readingname  all invalid characters and replaces them with the underscore \_. Also, if the Readingname is longer than MAXLEN\_RN it is pruned to this maximum length. The return value  is a Readingname that has only valid characters in it (see goodReadingName). If  was already valid,  equals .
+    $validName = makeReadingName($name);
+    This function removes from given Readingname $name all invalid characters and replaces them with the underscore \_. Also, if the Readingname is longer than MAXLEN\_RN it is pruned to this maximum length. The return value $validName is a Readingname that has only valid characters in it (see goodReadingName). If $name was already valid, $validName equals $name.
 
 - **ReadingsAge** (positional)
 - **ReadingsNum** (positional)