From b5880e607fe092073d92ba8e304726dfc89119bc Mon Sep 17 00:00:00 2001 From: Somasundaram Ayyappan Date: Mon, 18 Jul 2016 02:30:31 +0530 Subject: [PATCH] Doc fixes (#102) * replace block api refs with inline * fix inline link refs in static method sections * link fixes in few more files --- docs/reference/models/block.md | 4 ++-- docs/reference/models/character.md | 4 ++-- docs/reference/models/data.md | 2 +- docs/reference/models/document.md | 2 +- docs/reference/models/inline.md | 14 +++++++------- docs/reference/models/mark.md | 4 ++-- docs/reference/models/selection.md | 2 +- docs/reference/models/state.md | 4 ++-- docs/reference/models/text.md | 2 +- 9 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/reference/models/block.md b/docs/reference/models/block.md index 6aafbb466..4684f103f 100644 --- a/docs/reference/models/block.md +++ b/docs/reference/models/block.md @@ -20,8 +20,8 @@ Block nodes may contain nested block nodes, inline nodes, and text nodes—just - [`length`](#length) - [`text`](#text) - [Static Methods](#static-methods) - - [`Block.create`](#block-create) - - [`Block.createList`](#block-createlist) + - [`Block.create`](#blockcreate) + - [`Block.createList`](#blockcreatelist) - [Node Methods](#node-methods) diff --git a/docs/reference/models/character.md b/docs/reference/models/character.md index a9280f0e8..d6fea42e6 100644 --- a/docs/reference/models/character.md +++ b/docs/reference/models/character.md @@ -13,8 +13,8 @@ Characters are how Slate associates [`Marks`](./mark.md) with a range of text, f - [`marks`](#marks) - [`text`](#text) - [Static Methods](#static-methods) - - [`Character.create`](#character-create) - - [`Character.createList`](#character-createlist) + - [`Character.create`](#charactercreate) + - [`Character.createList`](#charactercreatelist) ## Properties diff --git a/docs/reference/models/data.md b/docs/reference/models/data.md index a13b7f04d..febfadb1f 100644 --- a/docs/reference/models/data.md +++ b/docs/reference/models/data.md @@ -10,7 +10,7 @@ Data is simply a thin wrapper around [`Immutable.Map`](https://facebook.github.i A data object can have any properties associated with it. - [Static Methods](#static-methods) - - [`Data.create`](#data-create) + - [`Data.create`](#datacreate) ## Static Methods diff --git a/docs/reference/models/document.md b/docs/reference/models/document.md index 771df2c5f..9d6cd0f82 100644 --- a/docs/reference/models/document.md +++ b/docs/reference/models/document.md @@ -16,7 +16,7 @@ Documents are made up of block nodes, inline nodes, and text nodes—just like i - [`length`](#length) - [`text`](#text) - [Static Methods](#static-methods) - - [`Document.create`](#document-create) + - [`Document.create`](#documentcreate) - [Node Methods](#node-methods) diff --git a/docs/reference/models/inline.md b/docs/reference/models/inline.md index 38c385e86..666399e35 100644 --- a/docs/reference/models/inline.md +++ b/docs/reference/models/inline.md @@ -20,8 +20,8 @@ Inline nodes may contain nested inline nodes and text nodes—just like in the D - [`length`](#length) - [`text`](#text) - [Static Methods](#static-methods) - - [`Inline.create`](#inline-create) - - [`Inline.createList`](#inline-createlist) + - [`Inline.create`](#inlinecreate) + - [`Inline.createList`](#inlinecreatelist) - [Node Methods](#node-methods) @@ -85,15 +85,15 @@ A concatenated string of all of the descendant [`Text`](./text.md) nodes of this ## Static Methods -### `Block.create` -`Block.create(properties: Object) => Block` +### `Inline.create` +`Inline.create(properties: Object) => Block` Create a block from a plain Javascript object of `properties`. -### `Block.createList` -`Block.createList(array: Array) => List` +### `Inline.createList` +`Inline.createList(array: Array) => List` -Create a list of block nodes from a plain Javascript `array`. +Create a list of inline nodes from a plain Javascript `array`. ## Node Methods diff --git a/docs/reference/models/mark.md b/docs/reference/models/mark.md index adec2f463..6efd9fd02 100644 --- a/docs/reference/models/mark.md +++ b/docs/reference/models/mark.md @@ -11,8 +11,8 @@ A formatting mark that can be associated with [`Characters`](./character.md). Ma - [`data`](#data) - [`type`](#type) - [Static Methods](#static-methods) - - [`Mark.create`](#mark-create) - - [`Mark.createSet`](#mark-createset) + - [`Mark.create`](#markcreate) + - [`Mark.createSet`](#markcreateset) ## Properties diff --git a/docs/reference/models/selection.md b/docs/reference/models/selection.md index 9b8b8cf77..b76748679 100644 --- a/docs/reference/models/selection.md +++ b/docs/reference/models/selection.md @@ -28,7 +28,7 @@ Often times, you don't need to specifically know which point is the "anchor" and - [`startKey`](#startkey) - [`startOffset`](#startoffset) - [Static Methods](#static-methods) - - [`Selection.create`](#create) + - [`Selection.create`](#selectioncreate) - [Checking Methods](#checking-methods) - [`has{Edge}AtEndOf`](#hasedgeatendof) - [`has{Edge}AtStartOf`](#hasedgeatstartof) diff --git a/docs/reference/models/state.md b/docs/reference/models/state.md index feb5fc359..75ac91552 100644 --- a/docs/reference/models/state.md +++ b/docs/reference/models/state.md @@ -31,8 +31,8 @@ For convenience, in addition to transforms, many of the [`Selection`](./selectio - [`isExpanded`](#isExpanded) - [`isFocused`](#isfocused) - [`isForward`](#isForward) -- [Static Methods](#static) - - [`State.create`](#create) +- [Static Methods](#static-methods) + - [`State.create`](#statecreate) - [Methods](#methods) - [`transform`](#transform) diff --git a/docs/reference/models/text.md b/docs/reference/models/text.md index a12afbbd7..00b64f909 100644 --- a/docs/reference/models/text.md +++ b/docs/reference/models/text.md @@ -15,7 +15,7 @@ A text node in a Slate [`Document`](./document.md). Text nodes are always the bo - [`length`](#length) - [`text`](#text) - [Static Methods](#static-methods) - - [`Text.create`](#text-create) + - [`Text.create`](#textcreate) ## Properties