aboutsummaryrefslogtreecommitdiffstats
path: root/packages/react-docs/src/utils
diff options
context:
space:
mode:
authorF. Eugene Aumson <feuGeneA@users.noreply.github.com>2018-09-26 03:22:40 +0800
committerF. Eugene Aumson <feuGeneA@users.noreply.github.com>2018-09-26 03:51:32 +0800
commit6174267f6940dce57fde8933c6282814d070b892 (patch)
treed9e98a45fb0d0fc960b38f5b8ee088c3fab48084 /packages/react-docs/src/utils
parente8c8d3e722676a250428795f70143ed3e5289cbc (diff)
downloaddexon-sol-tools-6174267f6940dce57fde8933c6282814d070b892.tar
dexon-sol-tools-6174267f6940dce57fde8933c6282814d070b892.tar.gz
dexon-sol-tools-6174267f6940dce57fde8933c6282814d070b892.tar.bz2
dexon-sol-tools-6174267f6940dce57fde8933c6282814d070b892.tar.lz
dexon-sol-tools-6174267f6940dce57fde8933c6282814d070b892.tar.xz
dexon-sol-tools-6174267f6940dce57fde8933c6282814d070b892.tar.zst
dexon-sol-tools-6174267f6940dce57fde8933c6282814d070b892.zip
fix: explain why tslint rule is disabled
https://github.com/0xProject/0x-monorepo/pull/1004#discussion_r219976511 https://github.com/0xProject/0x-monorepo/pull/1004
Diffstat (limited to 'packages/react-docs/src/utils')
-rw-r--r--packages/react-docs/src/utils/typedoc_utils.ts1
1 files changed, 1 insertions, 0 deletions
diff --git a/packages/react-docs/src/utils/typedoc_utils.ts b/packages/react-docs/src/utils/typedoc_utils.ts
index d235b4406..09f995672 100644
--- a/packages/react-docs/src/utils/typedoc_utils.ts
+++ b/packages/react-docs/src/utils/typedoc_utils.ts
@@ -468,6 +468,7 @@ export class TypeDocUtils {
methodIfExists = this._convertMethod(entity.declaration, isConstructor, sectionName);
} else if (entity.type === TypeDocTypes.Tuple) {
tupleElementsIfExists = _.map(entity.elements, el => {
+ // the following line is required due to an open tslint issue, https://github.com/palantir/tslint/issues/3540
// tslint:disable-next-line:no-unnecessary-type-assertion
return { name: el.name, typeDocType: el.type as TypeDocTypes };
});