Skip to content

Commit ff309f8

Browse files
committed
Remove placeholder for params, waste space
1 parent 5a52af6 commit ff309f8

File tree

2 files changed

+2
-44
lines changed

2 files changed

+2
-44
lines changed

bin/docs_scripts/doc_constant.py

Lines changed: 1 addition & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -4,49 +4,9 @@
44

55
from typing import Dict, Union
66

7-
# Types that are built-in to Python and don't need to be documented
8-
NO_DOCS_TYPES = [
9-
"Client",
10-
"any",
11-
"int",
12-
"float",
13-
"bool",
14-
"dict",
15-
"list",
16-
"str",
17-
"tuple",
18-
"set",
19-
"frozenset",
20-
"bytes",
21-
"bytearray",
22-
"memoryview",
23-
"range",
24-
"slice",
25-
"complex",
26-
"Union",
27-
"Optional",
28-
"Any",
29-
"Callable",
30-
"Type",
31-
"TypeVar",
32-
"Generic",
33-
"Literal",
34-
"ClassVar",
35-
"Final",
36-
"Annotated",
37-
"NotRequired",
38-
"Required",
39-
"None",
40-
"NoneType",
41-
"object",
42-
"Unpack",
43-
"BaseException",
44-
"Exception",
45-
]
46-
477
# Documentation generation metadata
488
DOCUMENTATION_METADATA = {
49-
"hogRef": "0.1",
9+
"hogRef": "0.2",
5010
"slugPrefix": "posthog-python",
5111
"specUrl": "https://github.com/PostHog/posthog-python",
5212
}

bin/docs_scripts/generate_json_schemas.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
from typing import get_origin, get_args, Union
1212
from textwrap import dedent
1313
from doc_constant import (
14-
NO_DOCS_TYPES,
1514
DOCUMENTATION_METADATA,
1615
DOCSTRING_PATTERNS,
1716
OUTPUT_CONFIG,
@@ -187,7 +186,7 @@ def analyze_parameter(param: inspect.Parameter, docstring: str = "") -> dict:
187186
param_type = get_type_name(type(param.default))
188187

189188
# Extract parameter description from Args section
190-
param_description = f"Parameter: {param.name}"
189+
param_description = ""
191190
if docstring:
192191
# Look for Args section and extract description for this parameter
193192
args_section_match = re.search(
@@ -425,7 +424,6 @@ def generate_sdk_documentation():
425424
"id": "posthog-python",
426425
"hogRef": DOCUMENTATION_METADATA["hogRef"],
427426
"info": sdk_info,
428-
"noDocsTypes": NO_DOCS_TYPES,
429427
"types": types_list,
430428
"classes": classes_list,
431429
}

0 commit comments

Comments
 (0)