Skip to content

Commit

Permalink
Use new script
Browse files Browse the repository at this point in the history
  • Loading branch information
oandregal committed Mar 6, 2019
1 parent 9dd9d5f commit 47fff58
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 12 deletions.
2 changes: 2 additions & 0 deletions bin/update-readmes.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ const childProcess = require( 'child_process' );
const packages = [
'e2e-test-utils',
'element',
'escape-html',
];

let aggregatedExitCode = 0;
Expand All @@ -14,6 +15,7 @@ packages.forEach( ( packageName ) => {
`packages/${ packageName }/src/index.js`,
`--output packages/${ packageName }/README.md`,
'--to-token',
'--ignore "unstable|experimental"',
];
const pathToDocGen = path.join( __dirname, '..', 'node_modules', '.bin', 'docgen' );
const { status, stderr } = childProcess.spawnSync(
Expand Down
12 changes: 6 additions & 6 deletions packages/escape-html/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ named references (i.e. ambiguous ampersand) are are still permitted.

**Returns**

`string` Escaped string.
`string`: Escaped string.

### escapeAttribute

Expand All @@ -58,7 +58,7 @@ any literal U+0022 QUOTATION MARK characters (")"

**Returns**

`string` Escaped attribute value.
`string`: Escaped attribute value.

### escapeHTML

Expand All @@ -79,7 +79,7 @@ ambiguous ampersand."

**Returns**

`string` Escaped HTML element value.
`string`: Escaped HTML element value.

### escapeLessThan

Expand All @@ -93,7 +93,7 @@ Returns a string with less-than sign replaced.

**Returns**

`string` Escaped string.
`string`: Escaped string.

### escapeQuotationMark

Expand All @@ -107,7 +107,7 @@ Returns a string with quotation marks replaced.

**Returns**

`string` Escaped string.
`string`: Escaped string.

### isValidAttributeName

Expand All @@ -121,7 +121,7 @@ Returns true if the given attribute name is valid, or false otherwise.

**Returns**

`boolean` Whether attribute is valid.
`boolean`: Whether attribute is valid.


<!-- END TOKEN(Autogenerated API docs) -->
Expand Down
6 changes: 0 additions & 6 deletions packages/escape-html/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,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 47fff58

Please sign in to comment.