Merge pull request #267 from ditrit/bugfix/documentation

Fix bad documentation
ditrit · Aug 2, 2024 · f074bad · f074bad
2 parents 90c1530 + 0f6e8a4
commit f074bad
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/src/models/Component.js b/src/models/Component.js
@@ -386,7 +386,7 @@ class Component extends FileInformation {
   }
 
   /**
-   * Set error if is required and value is null.
+   * Set error if the required attribute is not present or if its value is null.
    * @param {ParserLog[]} [errors] - Errors to set, can be null.
    * @returns {ParserLog[]} All attributes error.
    */

diff --git a/src/models/ComponentAttribute.js b/src/models/ComponentAttribute.js
@@ -285,8 +285,9 @@ class ComponentAttribute {
   }
 
   /**
-   * Set error if is required and value is null.
+   * Set error if the required attribute is not present or if its value is null.
    * @param {ParserLog[]} [errors] - Errors to set, can be null.
+   * @param {string} [id] - Component id.
    * @returns {ParserLog[]} All attributes error.
    */
   validateRequiredAttributes(errors = [], id = null) {