Skip to content

Conversation

vrossum
Copy link
Contributor

@vrossum vrossum commented Mar 18, 2025

DOC: _multivariate.py
Extended documentation of random_correlation matrix.

  • state conditions on eig input.
  • describe properties of output

Extended documentation of random_correlation matrix
@melissawm melissawm added the Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org label Mar 18, 2025
@melissawm
Copy link
Member

melissawm commented Mar 18, 2025

Hi @vrossum !

  • If you are addressing an existing issue, please add the expression Closes #<issue number> to your PR description.
  • If you can, please make sure you use our [commit message conventions] and, for this case, you can also use [docs only] at the end of your commit message to make sure we don't spend CI minutes unnecessarily. (see https://docs.scipy.org/doc/scipy/dev/contributor/continuous_integration.html#skipping for more information)

EDIT: I also just noticed you made your changes from your main branch. This is generally not a good idea - we recommend always using feature branches for PRs. See https://docs.scipy.org/doc/scipy/dev/contributor/development_workflow.html#basic-workflow

Thank you!

@melissawm melissawm changed the title Update _multivariate.py DOC: stats: Extend documentation of random_correlation matrix Mar 18, 2025
Copy link
Member

@j-bowhay j-bowhay left a comment

Choose a reason for hiding this comment

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

Thanks for your first contribution to SciPy, keep them coming!

@j-bowhay j-bowhay merged commit 30609cc into scipy:main Mar 28, 2025
@j-bowhay j-bowhay added this to the 1.16.0 milestone Mar 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.stats
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants