Skip to content

doc: add link to the plot_gmm_covariances example #31249

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

natmokval
Copy link
Contributor

@natmokval natmokval commented Apr 24, 2025

Towards #30621.

This PR adds a reference to the 'plot_gmm_covariances.py' example.

The 'plot_gmm_covariances' example is already referenced in the User Guide. I added a link to make the example visible from the API documentation as well, but I'm not sure if that's necessary. I believe no additional references are needed, since it's already sufficiently covered in the User Guide.

Copy link

github-actions bot commented Apr 24, 2025

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: ebd4830. Link to the linter CI: here

Copy link
Contributor

@StefanieSenger StefanieSenger left a comment

Choose a reason for hiding this comment

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

Thank you, @natmokval, that looks good to me. The location of the link in covariances_ docstring adds value for uses.

I would maybe move the link below the information on the shape (into line 637).

@StefanieSenger
Copy link
Contributor

@adrinjalali, do you think we can merge this?

@natmokval
Copy link
Contributor Author

I would maybe move the link below the information on the shape (into line 637).

Thanks @StefanieSenger for reviewing this PR. I did as you suggested and moved the link below the information on the shape.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants