jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 12:40:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix \n in field descriptions breaks markdown table (#5792)

Browse Source
This commit is contained in:
teh_coderer
2023-11-24 19:27:46 -05:00
committed by GitHub
parent dd833ffbac
commit a31df4b300
1 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
website/generate_platform_v4_markdown.py
View File

@@ -395,7 +395,7 @@ def get_command_meta(path: str, route_map: Dict[str, Any]) -> Dict[str, Any]:
get_annotation_type(param_type),
),
"optional": optional,
"doc": description,
"doc": (description or "").replace("\n", "<br/>").strip(),
}
)
@@ -449,14 +449,16 @@ def get_command_meta(path: str, route_map: Dict[str, Any]) -> Dict[str, Any]:
for name, field in data_fields.items():
standard[name] = {
"type": get_annotation_type(field.annotation),
"doc": field.description,
"doc": (field.description or "").replace("\n", "<br/>").strip(),
}
else:
for name, field in query_fields.items():
if name not in obb_query_fields:
provider_params.setdefault(provider_name, {})[name] = {
"type": get_annotation_type(field.annotation),
"doc": field.description,
"doc": (field.description or "")
.replace("\n", "<br/>")
.strip(),
"optional": "True" if not field.is_required() else "False",
"default": str(field.default).replace(
"PydanticUndefined", ""
@@ -466,7 +468,9 @@ def get_command_meta(path: str, route_map: Dict[str, Any]) -> Dict[str, Any]:
if name not in providers["openbb"]["Data"]["fields"]:
provider_extras.setdefault(provider_name, {})[name] = {
"type": get_annotation_type(field.annotation),
"doc": field.description,
"doc": (field.description or "")
.replace("\n", "<br/>")
.strip(),
}
meta_command["schema"] = {