-
Notifications
You must be signed in to change notification settings - Fork 3.1k
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
Adding everything from Risk Metrics PR based on new main branch #1666
Conversation
Hey, thanks for the PR! It seems that the -w argument doesn't accept any integers. Perhaps it gets saved as a string? Could you also add a little bit more documentation about these ratios on the website? What I am mostly looking for is a quick explanation what the Omega Ratio is for example. You already link to an article within the code but it would be helpful if that explanation is briefly given within the Docs as well. Furthermore, could you add in an example to each command? You can do so by going into your own Fork GitHub location and directly editing the .md files. This allows you to drag and drop images thus you can simply run the command, save the image and drop it into the .md |
Should I also add a quick explanation of the ratio:s in the command help part (-h)? I'm a bit unsure how detailed it should be. |
Would be helpful to have some formulas and descriptions in the Hugo (which is what @JerBouma is suggesting) |
The -h text doesn't have to be so precise. You could say for the sharpe ratio for example "Determines the Sharpe Ratio over time which is the portfolio return minus the risk free return divided by the portfolio's standard deviation." In the Hugo docs you could give the formula, provide (a little bit of) background information and show one example. It doesn't have to be an entire paragraph and feel free to just link to your source, happy to approve this soon :) |
I've now added a description to the hugo. After having thought about it I think that the command help description is good as it is and instead I made the hugo documentation more precise. The command help shouldn't clutter up the entire terminal and be easy to use. Looking forward towards having this merged 👍 |
Description
Adding sh, so, om commands. This pr is based on the changes from #1515 that broke due to renameing.
How has this been tested?
Using the commands
Checklist:
Others
pre-commit install
.pytest tests/...
.