From a3eaca027052ab4d99d2a9e3ccd0cba1224fd94c Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Wed, 15 Apr 2020 08:44:15 +0200 Subject: [PATCH] Small doc cleanups (#2172) --- docs/README.md | 2 +- docs/cookbook/README.md | 2 +- packages/types/src/interfaces/state/definitions.ts | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/README.md b/docs/README.md index 02e76a7a58..1da91727b4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -21,7 +21,7 @@ footer: Apache-2 Licensed | Copyright © 2017-2020 polkadot-js authors and contr The API provides application developers the ability to query a node and interact with the Polkadot or Substrate chains using Javascript. Here you will find documentation and examples to get you started. ::: tip Getting started & Examples -[Jump right in](/start/) and get an overview on using the API in your projects, from installation all the way through to making it do magic. Already understand how things work and just want the examples? [The ApiPromise examples](/examples/promise/) provide some basic examples. +[Jump right in](/start/) and get an overview on using the API in your projects, from installation all the way through to making it do magic. Have things working and want tips? The [cookbook](/cookbook/) provides some tips and tricks. Getting started and want some full examples? [The ApiPromise examples](/examples/promise/) provide some basic examples. ::: ## The Polkadot Project diff --git a/docs/cookbook/README.md b/docs/cookbook/README.md index 2f7dbfbdb3..2345cf4d27 100644 --- a/docs/cookbook/README.md +++ b/docs/cookbook/README.md @@ -10,7 +10,7 @@ The following cookbook sections are available - - [Blocks](blocks.md) - Snippets around working with blocks and headers - [Storage](storage.md) - Snippets for working with storage -- [Transactions)](tx.md) - Snippets for working with transactions +- [Transactions](tx.md) - Snippets for working with transactions ... more to come. diff --git a/packages/types/src/interfaces/state/definitions.ts b/packages/types/src/interfaces/state/definitions.ts index 8ef9009452..88c963084d 100644 --- a/packages/types/src/interfaces/state/definitions.ts +++ b/packages/types/src/interfaces/state/definitions.ts @@ -45,7 +45,7 @@ export default { type: 'Vec' }, getPairs: { - description: 'Returns the keys with prefix, leave empty to get all the keys', + description: 'Returns the keys with prefix, leave empty to get all the keys (deprecated: Use getKeysPaged)', params: [ { name: 'prefix',