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

Portfolio docstring example fixes and some bugs #3431

Merged
merged 16 commits into from
Nov 18, 2022

Conversation

montezdesousa
Copy link
Contributor

@montezdesousa montezdesousa commented Nov 15, 2022

Description

  • Fixes docstring examples with errors
  • Fixes metric sub commands units changing to absolute values, ratios were being displayed in % format
  • Fixes metric volatility units
  • Fixes bug where portfolio controller was not displaying correct risk free rate in print_help
  • Changes PortfolioEngine class to its own file portfolio_engine.py
  • Changes metrics calculations to metrics_model.py file to follow allocation_model.py and attribution_model.py
  • moved unused code yahoofinance_model.py and reportlab_helpers.py to portfolio_analysis folder

How has this been tested?

python -m doctest -v openbb_terminal/portfolio/portfolio_model.py
python terminal.py ~/OpenBBTerminal/openbb_terminal/miscellaneous/scripts/portfolio/test_portfolio.openbb

@reviewpad reviewpad bot added the feat XL Extra Large feature label Nov 15, 2022
@montezdesousa montezdesousa added bug Fix bug portfolio Portfolio menu labels Nov 15, 2022
@montezdesousa montezdesousa marked this pull request as ready for review November 15, 2022 22:06
Copy link
Contributor

@piiq piiq left a comment

Choose a reason for hiding this comment

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

Since we're touching docstrings here, can you run pydocstyle on the portfolio folder?

@montezdesousa
Copy link
Contributor Author

Since we're touching docstrings here, can you run pydocstyle on the portfolio folder?

yes sir

@montezdesousa
Copy link
Contributor Author

Since we're touching docstrings here, can you run pydocstyle on the portfolio folder?

yes sir

All good in the portfolio main menu files (except controller). The optimization I'll look in other PR will be working tday

@montezdesousa montezdesousa added the do not merge Label to prevent pull request merge label Nov 16, 2022
Copy link
Contributor

@Chavithra Chavithra left a comment

Choose a reason for hiding this comment

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

Looks ok to me.

@montezdesousa montezdesousa removed the do not merge Label to prevent pull request merge label Nov 18, 2022
@montezdesousa montezdesousa merged commit 570e579 into main Nov 18, 2022
@montezdesousa montezdesousa deleted the portfolio_docstrings branch November 18, 2022 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fix bug feat XL Extra Large feature portfolio Portfolio menu
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants