Skip to content

Commit

Permalink
Update notes.
Browse files Browse the repository at this point in the history
  • Loading branch information
danfuzz committed Nov 22, 2024
1 parent 87ad811 commit 3f638ef
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
5 changes: 2 additions & 3 deletions src/sexp/export/Sexp.js
Original file line number Diff line number Diff line change
Expand Up @@ -150,9 +150,8 @@ 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. The main use for this is that this is what Jest
* uses when printing out equality errors in test cases.
*
* @param {?string} key_unused The property name / stringified index where the
* instance was fetched from.
Expand Down
3 changes: 2 additions & 1 deletion src/valvis/export/VisitDef.js
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,8 @@ export class VisitDef extends BaseDefRef {
*
* **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. The main intended use case for this is logging.
* as this method's results. The main use for this is that this is what Jest
* uses when printing out equality errors in test cases.
*
* @param {?string} key_unused The property name / stringified index where the
* instance was fetched from.
Expand Down
3 changes: 2 additions & 1 deletion src/valvis/export/VisitRef.js
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,8 @@ export class VisitRef extends BaseDefRef {
*
* **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. The main intended use case for this is logging.
* as this method's results. The main use for this is that this is what Jest
* uses when printing out equality errors in test cases.
*
* @param {?string} key_unused The property name / stringified index where the
* instance was fetched from.
Expand Down

0 comments on commit 3f638ef

Please sign in to comment.