From d160e7f47a67e72453c0def86c879f773867d763 Mon Sep 17 00:00:00 2001 From: Dan Bornstein Date: Fri, 25 Oct 2024 11:30:37 -0700 Subject: [PATCH] Reflow jsdoc. --- src/decon/export/Sexp.js | 6 +++--- src/loggy-intf/export/LogPayload.js | 4 ++-- src/loggy-intf/private/HumanVisitor.js | 4 ++-- src/valvis/export/BaseDefRef.js | 8 ++++---- src/valvis/export/BaseValueVisitor.js | 4 ++-- 5 files changed, 13 insertions(+), 13 deletions(-) diff --git a/src/decon/export/Sexp.js b/src/decon/export/Sexp.js index b3bdd93d2..70fc9fdfe 100644 --- a/src/decon/export/Sexp.js +++ b/src/decon/export/Sexp.js @@ -150,9 +150,9 @@ export class Sexp { * * **Note:** This is not intended for high-fidelity data encoding, in that the * result is ambiguous with plain objects that happen to have the same shape - * as this method's results, and in that the conversion of the {@link - * #functor} is lossy unless it is a string per se. The main intended use - * case for this is logging. + * as this method's results, and in that the conversion of the + * {@link #functor} is lossy unless it is a string per se. The main intended + * use case for this is logging. * * @param {?string} key_unused The property name / stringified index where the * instance was fetched from. diff --git a/src/loggy-intf/export/LogPayload.js b/src/loggy-intf/export/LogPayload.js index d511c0a1e..2c3223227 100644 --- a/src/loggy-intf/export/LogPayload.js +++ b/src/loggy-intf/export/LogPayload.js @@ -102,8 +102,8 @@ export class LogPayload extends EventPayload { * properties for each of the properties available on instances, except that * `stack` is omitted if `this.stack` is `null`. Everything except `.args` on * the result is guaranteed to be JSON-encodable, and `.args` will be - * JSON-encodable as long as `this.args` is, since they will be the exact - * same object. + * JSON-encodable as long as `this.args` is, since they will be the exact same + * object. * * @returns {object} The plain object representation of this instance. */ diff --git a/src/loggy-intf/private/HumanVisitor.js b/src/loggy-intf/private/HumanVisitor.js index d7bde47c7..840ba75e5 100644 --- a/src/loggy-intf/private/HumanVisitor.js +++ b/src/loggy-intf/private/HumanVisitor.js @@ -20,8 +20,8 @@ const chalk = Chalk.ON; /** * Visitor class which stringifies instances of {@link LogPayload} and all its * components. This produces an array whose elements are either strings or - * arrays (of strings or arrays of...), with the array nesting representing - * the hierarchical structure of instance. + * arrays (of strings or arrays of...), with the array nesting representing the + * hierarchical structure of instance. */ export class HumanVisitor extends BaseValueVisitor { /** diff --git a/src/valvis/export/BaseDefRef.js b/src/valvis/export/BaseDefRef.js index eb331f45f..53b938cda 100644 --- a/src/valvis/export/BaseDefRef.js +++ b/src/valvis/export/BaseDefRef.js @@ -108,8 +108,8 @@ export class BaseDefRef { /** * @returns {*} The result value of the visit. - * @throws {Error} Thrown if the visit was unsuccessful or is still - * in progress. + * @throws {Error} Thrown if the visit was unsuccessful or is still in + * progress. */ get value() { return this.#entry?.extractSync() ?? null; @@ -119,8 +119,8 @@ export class BaseDefRef { * Is this instance associated with the given visitor? * * @param {BaseValueVisitor} visitor The visitor in question. - * @returns {boolean} `true` if this instance's associated visitor is in - * fact `visitor`. + * @returns {boolean} `true` if this instance's associated visitor is in fact + * `visitor`. */ isAssociatedWith(visitor) { return this.#entry?.isAssociatedWith(visitor) ?? false; diff --git a/src/valvis/export/BaseValueVisitor.js b/src/valvis/export/BaseValueVisitor.js index 3468b3a42..5da57c009 100644 --- a/src/valvis/export/BaseValueVisitor.js +++ b/src/valvis/export/BaseValueVisitor.js @@ -578,8 +578,8 @@ export class BaseValueVisitor { } /** - * Visits the given value as a "sub-visit" of the main visit. This can be - * used in concrete subclasses, for example, to visit the various pieces of + * Visits the given value as a "sub-visit" of the main visit. This can be used + * in concrete subclasses, for example, to visit the various pieces of * instances, where a simple object property visit wouldn't suffice. * * @param {*} node Value to visit.