#349 - added docs comments #357
Conversation
|
Following the build log, removing those two lines from test, is causing further tests to fail. |
|
Found same error in different PR build log , #356 @sindresorhus |
|
Include all the text from the options in the readme, not just the first sentence. Also document the methods and include a code example. |
| password?: string; | ||
|
|
||
| /** | ||
| * Scale webpage number times. |
There was a problem hiding this comment.
This is not a valid sentence.
| options?: Options; | ||
| } | ||
|
|
||
| /** | ||
| * Set the destination directory. |
There was a problem hiding this comment.
This comment is not correct. The type is the destination directory.
| * Delay capturing the screenshot (seconds). | ||
| * | ||
| * @default 0 | ||
| */ |
There was a problem hiding this comment.
I changed my comment style. See sindresorhus/typescript-definition-style-guide@6a256ee
| cookies?: (string | {[key: string]: string})[]; | ||
|
|
||
| /** | ||
| * Define a customized filename using Lo-Dash templates. |
There was a problem hiding this comment.
The readme contains a lot more info that is missing here.
Rebase from |
how should I add type, for example, Type: |
|
It's documented in https://github.com/sindresorhus/typescript-definition-style-guide which is linked to from the issue. |
|
Ping |
|
Sorry for inactivity, Can I continue this work, please? |
Fixes #349 Added docs TS/JS comments
IssueHunt Summary
IssueHunt has been backed by the following sponsors. Become a sponsor