Skip to content

Commit dce0a40

Browse files
committed
docs: update
1 parent 28fa65d commit dce0a40

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

docs/rules/valid-types.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -846,5 +846,9 @@ function quux() {
846846

847847
}
848848
// Settings: {"jsdoc":{"mode":"typescript"}}
849+
850+
/**
851+
* @returns {Promise<{publicKey, privateKey}>} - The public and private key
852+
*/
849853
````
850854

src/bin/generateDocs.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ const assertDocsAreUpToDate = async () => {
258258
const isUpToDate = fs.readFileSync(docPath, 'utf8') === docContent;
259259

260260
if (!isUpToDate) {
261-
throw new Error('Readme is not up to date, please run `npm run create-docs` to update it.');
261+
throw new Error('Docs are not up to date, please run `npm run create-docs` to update it.');
262262
}
263263
}
264264
};

0 commit comments

Comments
 (0)