feat(python): show argument types for functions with multiple signatu…

…res (#46)
apify · Jan 22, 2025 · e586f60 · e586f60
1 parent f34ff19
commit e586f60
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 5 deletions.
diff --git a/packages/plugin/package.json b/packages/plugin/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@apify/docusaurus-plugin-typedoc-api",
-  "version": "4.3.11",
+  "version": "4.3.12",
   "description": "Docusaurus plugin that provides source code API documentation powered by TypeDoc. ",
   "keywords": [
     "docusaurus",

diff --git a/packages/plugin/src/components/MemberSignatureTitle.tsx b/packages/plugin/src/components/MemberSignatureTitle.tsx
@@ -12,9 +12,10 @@ export interface MemberSignatureTitleProps {
 	useArrow?: boolean;
 	hideName?: boolean;
 	sig: TSDSignatureReflection & { modifiers?: string[] };
+	hasMultipleSignatures?: boolean;
 }
 
-export function MemberSignatureTitle({ useArrow, hideName, sig }: MemberSignatureTitleProps) {
+export function MemberSignatureTitle({ useArrow, hideName, sig, hasMultipleSignatures }: MemberSignatureTitleProps) {
 	const { isPython } = usePluginData('docusaurus-plugin-typedoc-api') as GlobalData;
 	// add `*` before the first keyword-only parameter
 	const parametersCopy = sig.parameters?.slice() ?? [];
@@ -56,7 +57,7 @@ export function MemberSignatureTitle({ useArrow, hideName, sig }: MemberSignatur
 					<span>
 						{param.flags?.isRest && <span className="tsd-signature-symbol">...</span>}
 						{escapeMdx(param.name)}
-						{!isPython && (
+						{!isPython || hasMultipleSignatures && (
 							<>
 								<span className="tsd-signature-symbol">
 									{(param.flags?.isOptional || 'defaultValue' in param) && '?'}

diff --git a/packages/plugin/src/components/MemberSignatures.tsx b/packages/plugin/src/components/MemberSignatures.tsx
@@ -40,7 +40,7 @@ export function MemberSignatures({ inPanel, sigs }: MemberSignaturesProps) {
 							}
 						>
 							<Icon reflection={sig} />
-							<MemberSignatureTitle sig={sig} />
+							<MemberSignatureTitle hasMultipleSignatures={sigs.length > 1} sig={sig} />
 						</li>
 					))}
 				</ul>

diff --git a/playground/python/src/foo.py b/playground/python/src/foo.py
@@ -46,7 +46,7 @@ def foo(self, param: str, param2: int):
         """
         print("foo")
 
-    def foo(self, param: str, param2: int = 0, **kwargs: Unpack[FooFooArguments]):
+    def foo(self, param: str, param2: int = 0):
         """This is the foo method of the Foo class.
         
         Args:
-Original file line number
+Diff line change
@@ Expand Up @@
     							}
     						>
     							<Icon reflection={sig} />
-    							<MemberSignatureTitle sig={sig} />
+    							<MemberSignatureTitle hasMultipleSignatures={sigs.length > 1} sig={sig} />
     						</li>
     					))}
     				</ul>
@@ Expand Down @@