From 9349752baa3d17b8c8d25eec0c4594f1f547fceb Mon Sep 17 00:00:00 2001 From: Fabio Berger Date: Thu, 15 Feb 2018 23:56:19 -0700 Subject: Add hack comment explaining param count short-cut --- packages/website/ts/pages/documentation/method_signature.tsx | 3 +++ 1 file changed, 3 insertions(+) (limited to 'packages/website/ts') diff --git a/packages/website/ts/pages/documentation/method_signature.tsx b/packages/website/ts/pages/documentation/method_signature.tsx index f94524b48..22294e428 100644 --- a/packages/website/ts/pages/documentation/method_signature.tsx +++ b/packages/website/ts/pages/documentation/method_signature.tsx @@ -24,6 +24,9 @@ export const MethodSignature: React.SFC = (props: MethodSi const sectionName = constants.TYPES_SECTION_NAME; const parameters = renderParameters(props.method, props.docsInfo, sectionName, props.typeDefinitionByName); const paramStringArray: any[] = []; + // HACK: For now we don't put params on newlines if there are less then 2 of them. + // Ideally we would check the character length of the resulting method signature and + // if it exceeds the available space, put params on their own lines. const hasMoreThenTwoParams = parameters.length > 2; _.each(parameters, (param: React.ReactNode, i: number) => { const finalParam = hasMoreThenTwoParams ? ( -- cgit v1.2.3