Skip to content

Commit

Permalink
docs: demo annotations
Browse files Browse the repository at this point in the history
  • Loading branch information
turadg committed Nov 28, 2023
1 parent 1d588ba commit f348ad4
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 1 deletion.
3 changes: 2 additions & 1 deletion packages/assert/src/types.js
Original file line number Diff line number Diff line change
Expand Up @@ -193,12 +193,13 @@
* payload itself is still passed unquoted to the console as it would be
* without `quote`.
*
* @example
* For example, the following will reveal the expected sky color, but not the
* actual incorrect sky color, in the thrown error's message:
* ```js
* sky.color === expectedColor || Fail`${sky.color} should be ${quote(expectedColor)}`;
* ```
*
* @example
* The normal convention is to locally rename `details` to `X` and `quote` to `q`
* like `const { details: X, quote: q } = assert;`, so the above example would then be
* ```js
Expand Down
1 change: 1 addition & 0 deletions packages/governance/src/question.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ const QuorumRule = /** @type {const} */ ({
const positionIncluded = (positions, p) => positions.some(e => keyEQ(e, p));

/**
* @internal
* @param {QuestionSpec} allegedQuestionSpec
* @returns {QuestionSpec}
*/
Expand Down
1 change: 1 addition & 0 deletions packages/notifier/src/storesub.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import { subscribeEach } from './subscribe.js';
/**
* NB: does not yet survive upgrade https://github.com/Agoric/agoric-sdk/issues/6893
*
* @alpha

Check warning on line 13 in packages/notifier/src/storesub.js

View workflow job for this annotation

GitHub Actions / lint-rest

Invalid JSDoc tag name "alpha"
* @template T
* @param {Subscriber<T>} subscriber
* @param {(v: T) => void} consumeValue
Expand Down

0 comments on commit f348ad4

Please sign in to comment.