Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Terminal Docs Auto Generation #3438

Merged
merged 49 commits into from
Nov 21, 2022
Merged

Terminal Docs Auto Generation #3438

merged 49 commits into from
Nov 21, 2022

Conversation

tehcoderer
Copy link
Contributor

Description

  • Summary of the change / bug fix.
  • Link # issue, if applicable.
  • Screenshot of the feature or the bug before/after fix, if applicable.
  • Relevant motivation and context.
  • List any dependencies that are required for this change.

How has this been tested?

  • Please describe the tests that you ran to verify your changes.
  • Provide instructions so we can reproduce.
  • Please also list any relevant details for your test configuration.
  • Make sure affected commands still run in terminal
  • Ensure the SDK still works
  • Check any related reports

Checklist:

Others

  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.

@reviewpad reviewpad bot added the feat M Medium T-Shirt size feature label Nov 16, 2022
@tehcoderer tehcoderer added docs Code documentation enhancement Enhancement refactor Refactor code do not merge Label to prevent pull request merge and removed feat M Medium T-Shirt size feature labels Nov 16, 2022
@reviewpad reviewpad bot added the feat M Medium T-Shirt size feature label Nov 16, 2022
@reviewpad reviewpad bot added the feat L Large T-Shirt size Feature label Nov 17, 2022
@tehcoderer tehcoderer removed the do not merge Label to prevent pull request merge label Nov 21, 2022
Chavithra
Chavithra approved these changes Nov 21, 2022
View reviewed changes
Copy link
Contributor

@Chavithra Chavithra left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few comments.

Looking good overall and I was able to run it and the generated doc seems ok.

Nice job @tehcoderer !

.gitignore
@@ -31,6 +31,7 @@ openbb_terminal/portfolio/portfolios/*
!openbb_terminal/reports/templates/*.ipynb
*_tests.csv
*_sdk_audit.csv
website/terminaltest
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is that?

website/generate_sdk_markdown.py
List,
Literal,
Optional,
)

from docstring_parser import parse
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As for now this is not a Terminal dependency.

Maybe we should add this as an extra so it will be easier to automate in a Github Action?

website/generate_sdk_markdown.py Outdated
self.func_attr[key] = self.func_attr[key].__wrapped__
if "__wrapped__" in dir(self.func_attr[key]):
self.func_attr[key] = self.func_attr[key].__wrapped__
if "__wrapped__" in dir(func_attr):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe we should use inspect.unwrap

@Chavithra Chavithra merged commit 6c9c6a6 into OpenBB-finance:main Nov 21, 2022
@tehcoderer tehcoderer deleted the terminal-autogen-docs branch February 16, 2023 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Chavithra Chavithra Chavithra approved these changes

Assignees
No one assigned
Labels
docs Code documentation enhancement Enhancement feat L Large T-Shirt size Feature feat M Medium T-Shirt size feature refactor Refactor code
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tehcoderer @Chavithra