Skip to content

doc: add link to the plot_gmm_covariances example#31249

Merged
adrinjalali merged 3 commits intoscikit-learn:mainfrom
natmokval:doc-add-link-plot_gmm_covariances-examples
May 6, 2025
Merged

doc: add link to the plot_gmm_covariances example#31249
adrinjalali merged 3 commits intoscikit-learn:mainfrom
natmokval:doc-add-link-plot_gmm_covariances-examples

Conversation

@natmokval
Copy link
Copy Markdown
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.

@github-actions
Copy link
Copy Markdown

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
Copy Markdown
Member

@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
Copy Markdown
Member

@adrinjalali, do you think we can merge this?

@natmokval
Copy link
Copy Markdown
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.

@StefanieSenger
Copy link
Copy Markdown
Member

That looks very good, thanks again @natmokval. :)

@adrinjalali adrinjalali merged commit ed9bcc7 into scikit-learn:main May 6, 2025
36 checks passed
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.

3 participants