From ddc013f090fdfd0ccf269598b9fe8f6248b42f30 Mon Sep 17 00:00:00 2001 From: jose-donato Date: Thu, 15 Dec 2022 16:33:05 +0000 Subject: [PATCH 1/2] fix: wordwrap --- website/generate_sdk_markdown.py | 2 +- website/generate_terminal_markdown.py | 2 +- website/package.json | 1 + website/src/theme/CodeBlock/Content/String.js | 2 +- 4 files changed, 4 insertions(+), 3 deletions(-) diff --git a/website/generate_sdk_markdown.py b/website/generate_sdk_markdown.py index 4e3e71e9dc11..31bdb1c3d86f 100644 --- a/website/generate_sdk_markdown.py +++ b/website/generate_sdk_markdown.py @@ -296,7 +296,7 @@ def generate_markdown_section(meta: Dict[str, Any]): markdown = ( f"{meta['description']}\n\nSource Code: [[link]({meta['source_code_url']})]\n\n" ) - markdown += f"```python\n{meta['func_def']}\n```\n\n" + markdown += f"```python wordwrap\n{meta['func_def']}\n```\n\n" markdown += "---\n\n## Parameters\n\n" if meta["params"]: diff --git a/website/generate_terminal_markdown.py b/website/generate_terminal_markdown.py index 358c3b9a1e32..5dd50846577c 100644 --- a/website/generate_terminal_markdown.py +++ b/website/generate_terminal_markdown.py @@ -171,7 +171,7 @@ def generate_markdown( # head meta https://docusaurus.io/docs/markdown-features/head-metadata markdown += f"# {cmd_meta['cmd_name']}\n\n{cmd_meta['description']}\n\n" - markdown += f"### Usage\n\n```python\n{cmd_meta['usage']}\n```\n\n" + markdown += f"### Usage\n\n```python wordwrap\n{cmd_meta['usage']}\n```\n\n" markdown += "---\n\n## Parameters\n\n" if cmd_meta["actions"]: diff --git a/website/package.json b/website/package.json index 89911afef644..72868971cc51 100644 --- a/website/package.json +++ b/website/package.json @@ -4,6 +4,7 @@ "private": true, "scripts": { "docusaurus": "docusaurus", + "dev": "docusaurus start", "start": "docusaurus start", "build": "docusaurus build", "swizzle": "docusaurus swizzle", diff --git a/website/src/theme/CodeBlock/Content/String.js b/website/src/theme/CodeBlock/Content/String.js index 884601d7eb89..ea672e060475 100644 --- a/website/src/theme/CodeBlock/Content/String.js +++ b/website/src/theme/CodeBlock/Content/String.js @@ -42,7 +42,7 @@ export default function CodeBlockString({ const showLineNumbers = showLineNumbersProp ?? containsLineNumbers(metastring); - const shouldWordwrapByDefault = code.startsWith("openbb.") + const shouldWordwrapByDefault = metastring?.includes("wordwrap") return ( Date: Thu, 15 Dec 2022 19:21:48 +0000 Subject: [PATCH 2/2] fix: test --- tests/website/test_generate_docs.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/website/test_generate_docs.py b/tests/website/test_generate_docs.py index 453da1795883..95413e115aa7 100644 --- a/tests/website/test_generate_docs.py +++ b/tests/website/test_generate_docs.py @@ -66,7 +66,7 @@ def __init__(self): Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/test/mock_func.py#L69)] -```python +```python wordwrap openbb.mock(arg1: Optional[str] = "Test", arg2: Optional[bool] = True) ```