Format documentation strings properly & refactor MetadataMd (#1858)

* Format docs strings properly

* Refactor MetadataMd
This commit is contained in:
Axel Chalon
2020-02-15 08:35:15 +01:00
committed by GitHub
parent 51c6262327
commit 26c59f6d6e
4 changed files with 236 additions and 205 deletions
+26
View File
@@ -0,0 +1,26 @@
{
"name": "substrate",
"description": "These are keys that are always available to the runtime implementation",
"items": [
{
"name": "changesTrieConfig(): `u32`",
"summary": "Changes trie configuration is stored under this key."
},
{
"name": "childStorageKeyPrefix(): `u32`",
"summary": "Prefix of child storage keys."
},
{
"name": "code(): `Bytes`",
"summary": "Wasm code of the runtime."
},
{
"name": "extrinsicIndex(): `u32`",
"summary": "Current extrinsic index (u32) is stored under this key."
},
{
"name": "heapPages(): `u64`",
"summary": "Number of wasm linear memory pages required for execution of the runtime."
}
]
}
-23
View File
@@ -1,23 +0,0 @@
---
## substrate
_These are keys that are always available to the runtime implementation_
### changesTrieConfig(): `u32`
- **summary**: Changes trie configuration is stored under this key.
### childStorageKeyPrefix(): `u32`
- **summary**: Prefix of child storage keys.
### code(): `Bytes`
- **summary**: Wasm code of the runtime.
### extrinsicIndex(): `u32`
- **summary**: Current extrinsic index (u32) is stored under this key.
### heapPages(): `u64`
- **summary**: Number of wasm linear memory pages required for execution of the runtime.
---