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
2018-09-25 15:22:40 -04:00
parent e8c8d3e722
commit 6174267f69
1 changed files with 1 additions and 0 deletions
--- 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 };
            });