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.

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

[Enhancement] ReferenceGenerator class in package_builder.py #6179

Merged
merged 31 commits into from
Mar 13, 2024

Conversation

the-praxs
Copy link
Contributor

@the-praxs the-praxs commented Mar 10, 2024

[Enhancement] ReferenceGenerator class in package_builder.py

  1. Why?

    For better code organization, scalability and maintenance

  2. What?

    • Class ReferenceGenerator is added in package_builder.py to create openbb/assets/reference.json file
    • Modified Platform Markdown Generator v2 to reflect changes from the reference.json for correct docs generation
    • Fixed docstrings for the quantitative, technical and econometrics functions
    • Added logic to check if all extensions are installed before generating the doc file
  3. Impact

    • Impact : Moderate
    • Impact Score = 18
    • Not backwards compatible due to breaking changes from the refactored examples
    • New class with code to create a new file may impact performance
    • Maintenance needed between all the classes and methods to ensure they work cohesively
  4. Testing Done

    • Auto-build and manual build triggered to check the change in files
    • Docs built and tested locally on npm server to ensure they are similar to the deployed docs
  5. Reviewer Notes

    macOS/Linux systems will show Reference column in random order on the local npm server. This is fine as it does not affect the docs when they are deployed on the website.

@github-actions github-actions bot added enhancement Enhancement platform OpenBB Platform v4 PRs for v4 labels Mar 10, 2024
@the-praxs the-praxs marked this pull request as ready for review March 11, 2024 07:55
@the-praxs the-praxs added the do not merge Label to prevent pull request merge label Mar 11, 2024
@the-praxs the-praxs removed the do not merge Label to prevent pull request merge label Mar 12, 2024
@the-praxs the-praxs added this pull request to the merge queue Mar 13, 2024
Merged via the queue into develop with commit 540f578 Mar 13, 2024
14 checks passed
@the-praxs the-praxs deleted the feature/reference-generator-package-builder branch March 13, 2024 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhancement platform OpenBB Platform v4 PRs for v4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants