quantus/api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix doc generation for DoubleMap (#1245)

Browse Source 
* Fix doc generation for DoubleMap

* Add ; - VSCode, why are you failing me? ...
This commit is contained in:
Jaco Greeff
2019-07-31 15:01:21 +02:00
committed by GitHub
parent dea3f79c84
commit 6999f8c71f
1 changed files with 16 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/types/src/scripts/MetadataMd.ts
+16 -8
View File
@@ -179,16 +179,24 @@ function addStorage (metadata: MetadataV7): string {
const orderedMethods = moduleMetadata.storage.unwrap().items.sort(sortByName);
return orderedMethods.reduce((md, func): string => {
const methodName = stringLowerFirst(func.name.toString());
const arg = func.type.isMap ? ('`' + func.type.asMap.key.toString() + '`') : '';
const arg =
func.type.isMap
? ('`' + func.type.asMap.key.toString() + '`')
: func.type.isDoubleMap
? ('`' + func.type.asDoubleMap.key1.toString() + ', ' + func.type.asDoubleMap.key2.toString() + '`')
: '';
const doc = func.documentation.reduce((md, doc): string => `${md} ${doc}`, '');
const type = func.modifier.isOptional
? `Option<${func.type}>`
: func.type;
const renderSignature = `${md}\n▸ **${methodName}**(${arg}): ` + '`' + type + '`';
const renderSummary = `${doc ? `\n- **summary**: ${doc}\n` : '\n'}`;
let result = (
func.type.isDoubleMap
? func.type.asDoubleMap.value
: func.type
).toString();
return renderSignature + renderSummary;
if (func.modifier.isOptional) {
result = `Option<${result}>`;
}
return `${md}\n▸ **${stringLowerFirst(func.name.toString())}**(${arg}): ` + '`' + result + '`' + `${doc ? `\n- **summary**: ${doc}\n` : '\n'}`;
}, renderSection);
}, '');