Skip to content

Commit

Permalink
Set up auto-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oandregal committed Mar 6, 2019
1 parent 8034d6b commit 5d57bda
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 10 deletions.
2 changes: 1 addition & 1 deletion bin/update-readmes.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ const childProcess = require( 'child_process' );
const packages = [
//'a11y',
//'autop',
//'blob',
'blob',
//'block-editor',
//'block-library',
//'block-serialization-default-parser',
Expand Down
6 changes: 3 additions & 3 deletions packages/blob/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Create a blob URL from a file.

**Returns**

`string` The blob URL.
`string`: The blob URL.

### getBlobByURL

Expand All @@ -42,7 +42,7 @@ Retrieve a file based on a blob URL. The file must have been created by

**Returns**

`?File` The file for the blob URL.
`?File`: The file for the blob URL.

### isBlobURL

Expand All @@ -56,7 +56,7 @@ Check whether a url is a blob url.

**Returns**

`boolean` Is the url a blob url?
`boolean`: Is the url a blob url?

### revokeBlobURL

Expand Down
6 changes: 0 additions & 6 deletions packages/blob/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,7 @@
"dependencies": {
"@babel/runtime": "^7.3.1"
},
"devDependencies": {
"@wordpress/docgen": "file:../docgen"
},
"publishConfig": {
"access": "public"
},
"scripts": {
"docs:generate": "docgen ./src/index.js --output ./README.md --to-token"
}
}

0 comments on commit 5d57bda

Please sign in to comment.