Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rich-text: set up autogenerated API docs #14220

Merged
merged 24 commits into from
Mar 7, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Ignore apply and changeListType symbols
  • Loading branch information
oandregal committed Mar 7, 2019
commit e4ac9b0472432a267493204b372f50631dc914df
2 changes: 1 addition & 1 deletion bin/generate-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ declare -a packages=(

for package in "${packages[@]}"
do
npx docgen packages/${package}/src/index.js --output packages/${package}/README.md --to-token --ignore ^unstable;
npx docgen packages/${package}/src/index.js --output packages/${package}/README.md --to-token --ignore "^unstable|^apply$|^changeListType$";
done
34 changes: 0 additions & 34 deletions packages/rich-text/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,6 @@ _This package assumes that your code will run in an **ES2015+** environment. If

<!-- START TOKEN(Autogenerated API docs) -->

### apply

[src/index.js#L27-L27](src/index.js#L27-L27)

Create an `Element` tree from a Rich Text value and applies the difference to
the `Element` tree contained by `current`. If a `multilineTag` is provided,
text separated by two new lines will be wrapped in an `Element` of that type.

**Parameters**

- **$1** `Object`: Named arguments.
- **$1.value** `Object`: Value to apply.
- **$1.current** `HTMLElement`: The live root node to apply the element tree to.
- **$1.multilineTag** `?string`: Multiline tag.
- **$1.multilineWrapperTags** `?Array`: Tags where lines can be found if nesting is possible.

### applyFormat

[src/index.js#L6-L6](src/index.js#L6-L6)
Expand All @@ -51,24 +35,6 @@ provided.

`Object` A new value with the format applied.

### changeListType

[src/index.js#L34-L34](src/index.js#L34-L34)

Changes the list type of the selected indented list, if any. Looks at the
currently selected list item and takes the parent list, then changes the list
type of this list. When multiple lines are selected, the parent lists are
takes and changed.

**Parameters**

- **value** `Object`: Value to change.
- **newFormat** `Object`: The new list format object. Choose between `{ type: 'ol' }` and `{ type: 'ul' }`.

**Returns**

`Object` The changed value.

### charAt

[src/index.js#L7-L7](src/index.js#L7-L7)
Expand Down