Refactor JSDoc

vfile · Jun 10, 2023 · e4904c0 · e4904c0
1 parent 3f85451
commit e4904c0
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/lib/index.js b/lib/index.js
@@ -11,7 +11,7 @@
  * @property {number} warn
  *   Warning messages (`fatal: false`).
  * @property {number} info
- *   Informational messages (`fatal: null | undefined`).
+ *   Informational messages (`fatal: undefined`).
  * @property {number} nonfatal
  *   Warning + info.
  * @property {number} total
@@ -21,7 +21,7 @@
 /**
  * Get stats for a file, list of files, or list of messages.
  *
- * @param {VFile | VFileMessage | Array<VFile | VFileMessage>} value
+ * @param {Array<VFile | VFileMessage> | VFile | VFileMessage} value
  *   File, message, or list of files or messages.
  * @returns {Statistics}
  *   Statistics.
@@ -54,7 +54,7 @@ export function statistics(value) {
    *
    * @param {Array<VFile | VFileMessage>} value
    *   List.
-   * @returns {void}
+   * @returns {undefined}
    *   Nothing.
    */
   function list(value) {
@@ -70,7 +70,7 @@ export function statistics(value) {
    *
    * @param {VFile | VFileMessage} value
    *   Value.
-   * @returns {void}
+   * @returns {undefined}
    *   Nothing.
    */
   function one(value) {

diff --git a/readme.md b/readme.md
@@ -109,7 +109,7 @@ Statistics (TypeScript type).
 
 *   `fatal` — fatal errors (`fatal: true`)
 *   `warn` — warning messages (`fatal: false`)
-*   `info` — informational messages (`fatal: null | undefined`)
+*   `info` — informational messages (`fatal: undefined`)
 *   `nonfatal` — warning or info messages
 *   `total` — all messages