Skip to content

Commit

Permalink
Reflow jsdoc.
Browse files Browse the repository at this point in the history
  • Loading branch information
danfuzz committed Oct 25, 2024
1 parent ff4c747 commit d160e7f
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
6 changes: 3 additions & 3 deletions src/decon/export/Sexp.js
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions src/loggy-intf/export/LogPayload.js
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand Down
4 changes: 2 additions & 2 deletions src/loggy-intf/private/HumanVisitor.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
/**
Expand Down
8 changes: 4 additions & 4 deletions src/valvis/export/BaseDefRef.js
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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;
Expand Down
4 changes: 2 additions & 2 deletions src/valvis/export/BaseValueVisitor.js
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit d160e7f

Please sign in to comment.