README.md Refresh#522
Open
FurretGoWalcc wants to merge 2 commits into
Open
Conversation
added 2 commits
June 6, 2026 13:37
2. Moved API ref and doc info to separate linked .md 3. Added quick links section in README.md. 4. Removed "Known issue" section. Will readd as a github issue 5. Removed dedicated Monte carlo section from readme. Instead, this was given a quick link to it's .md file in docs. 6. Resized reports and images, with links to full-sized variants linked.
aligning with parameter names. 2. Added notes and assumptions on "returns" object for users who provide their own returns object.
Author
|
If this is accepted, it is recommended to readd the "Known Issue" as a github issue:
Maybe some folks can fix it in a subsequent PR. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR addresses several areas where the current README.md could be improved, which would help new users to the library gain understanding.
Ideally, a global constant such as OBSERVATIONS_PER_YEARS or other should likely be added to give users the freedom to adjust QuantStat's functionality between calendar_year, weekly, market_days, other other abstract observation calendars, but for now, properly documenting the current assumptions will go a long way in reducing confusion on this point.