Improve sample_cov docstring with risk parity example and notes #640
Conversation
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
This PR improves the documentation for `sample_cov` by: - Adding a concrete example with real output values. - Clarifying the link to risk parity strategies. Closes PyPortfolio#423
Collaborator
|
This is a nice idea but I am not merging it for now because of consistency with the rest of the docs. At some point, we should do this for all the docstrings or none. Claude Code / Codex can probably help there! |
Contributor
|
All docstrings will actually be tested! Of course, the docstrings will created by an LLM modulo moderate manual changes |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 improves the documentation for
sample_covby: