rich-text: set up autogenerated API docs#14220
Merged
Conversation
Loading
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related to #14227
This PR sets up auto-generated API docs for the
rich-textpackage through thenpm run docs:buildcommand and updates its README file.Notable modifications
{type} [param], not{?type} param.{type|undefined}, not{?type}.insertObjectunregisterFormatTypeapply.changeListTypecharAtgetSelectionEndgetSelectionStartindentListItemsinsertLineBreakinsertLineSeparatorisEmptyLineLINE_SEPARATORoutdentListItemsunstableToDomTest instructions
packages/rich-text/README.mdwithin the start<!-- START TOKEN(Autogenerated API docs) -->and end<!-- END TOKEN(Autogenerated API docs) -->tokens.npm run docs:buildand verify they are re-created.