From 331b2adcb6f8d962e4ed19292fd2ab5838ba479e Mon Sep 17 00:00:00 2001 From: Nate Sesti Date: Tue, 12 Sep 2023 00:59:20 -0700 Subject: docs: :memo: major docs improvements --- docs/src/components/ClassPropertyRef.tsx | 34 +++++++++++++++++++++++++++++--- 1 file changed, 31 insertions(+), 3 deletions(-) (limited to 'docs/src/components/ClassPropertyRef.tsx') diff --git a/docs/src/components/ClassPropertyRef.tsx b/docs/src/components/ClassPropertyRef.tsx index 46664c4c..7246663b 100644 --- a/docs/src/components/ClassPropertyRef.tsx +++ b/docs/src/components/ClassPropertyRef.tsx @@ -4,8 +4,14 @@ interface ClassPropertyRefProps { name: string; details: string; required: boolean; + default: string; } +const PYTHON_TYPES = { + string: "str", + integer: "int", +}; + export default function ClassPropertyRef(props: ClassPropertyRefProps) { const details = JSON.parse(props.details); @@ -15,10 +21,32 @@ export default function ClassPropertyRef(props: ClassPropertyRefProps) {

{props.name}

- - {props.required && "REQUIRED"} + {props.required && ( + + REQUIRED + + )} + + {details.type && `(${PYTHON_TYPES[details.type] || details.type})`} - {details.type && `(${details.type})`} + + {props.default && ( + + {" "} + = {details.type === "string" && '"'} + {props.default} + {details.type === "string" && '"'} + + )}

{details.description}

-- cgit v1.2.3-70-g09d2