From bf99d48ccbfc42c51e4b3c28c6af20dbe72d96d4 Mon Sep 17 00:00:00 2001 From: Ian Storm Taylor Date: Mon, 28 Nov 2016 10:53:19 -0800 Subject: [PATCH] update node and utils docs --- docs/reference/models/node.md | 2 +- docs/reference/utils/utils.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/models/node.md b/docs/reference/models/node.md index ed5a52076..88b90f79c 100644 --- a/docs/reference/models/node.md +++ b/docs/reference/models/node.md @@ -44,7 +44,7 @@ A short-lived, unique identifier for the node. -By default, keys are not meant to be long-lived unique identifiers for nodes that you might store in a database, or elsewhere. They are meant purely to identify a node inside of a single Slate instance. For that reason, they are simply auto-incrementing strings. (eg. `'0'`, `'1'`, `'2'`, ...) +By default, keys are **not** meant to be long-lived unique identifiers for nodes that you might store in a database, or elsewhere. They are meant purely to identify a node inside of a single Slate instance. For that reason, they are simply auto-incrementing strings. (eg. `'0'`, `'1'`, `'2'`, ...) If you want to make your keys uniqueness long-lived, you'll need to supply your own key generating function via the [`setKeyGenerator`](../utils/utils.md#setkeygenerator) util. diff --git a/docs/reference/utils/utils.md b/docs/reference/utils/utils.md index f16ef9897..985b2117a 100644 --- a/docs/reference/utils/utils.md +++ b/docs/reference/utils/utils.md @@ -4,7 +4,7 @@ These are extra utility functions that ship with Slate that may be useful for certain use cases. -## `setKeyGenerator` +### `setKeyGenerator` `setKeyGenerator(generator: Function) => Void` Allows you to specify your own key generating function, instead of using Slate's built-in default generator which simply uses auto-incrementing number strings. (eg. `'0'`, `'1'`, `'2'`, ...)