Skip to content
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

DOC Document copy parameter and add link to the glossary entry #30307

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

Conversation

lamdang2k
Copy link
Contributor

Reference Issues/PRs

closes #28793

What does this implement/fix? Explain your changes.

Add a term copy to Glossary. Add link to this term in functions using the parameter copy.

Any other comments?

Copy link

github-actions bot commented Nov 19, 2024

✔️ Linting Passed

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

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

@StefanieSenger
Copy link
Contributor

StefanieSenger commented Nov 19, 2024

Hi @lamdang2k,

thanks for your contribution!

I cannot say so much on the behaviour of the copy param and if it is reliably like this for all the places where you have linked the new glossary entry.

But what do you think about adding this link implicitly, by linking copy directly to the glossary entry where it's mentioned, instead of adding "See the :term:`Glossary `."? It's leaner and nicer to read. It also gives some kind of a preview on what you will find there, that "see the Glossary" doesn't.

For instance like this: "Make a :term:`copy` of input data."

@StefanieSenger
Copy link
Contributor

StefanieSenger commented Nov 19, 2024

There are also copy_x and copy_X params in use in other places and maybe the issue with mutual_info* that the author of #28793 had broad up, can be resolved by re-naming (deprecation needed) the param to reflect its usage. Does that make sense?

At the same time, having copy, copy_x and copy_X terms explained in the glossary is a good idea. We could do both.

@@ -331,7 +332,7 @@ class AffinityPropagation(ClusterMixin, BaseEstimator):
of estimated clusters that stops the convergence.

copy : bool, default=True
Make a copy of input data.
Make a copy of input data. See the :term:`Glossary <copy>`.
Copy link
Contributor

@StefanieSenger StefanieSenger Nov 19, 2024

Choose a reason for hiding this comment

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

Suggested change
Make a copy of input data. See the :term:`Glossary <copy>`.
Make a :term:`copy` of input data.

Rather like this?

@lamdang2k
Copy link
Contributor Author

lamdang2k commented Nov 20, 2024

There are also copy_x and copy_X params in use in other places and maybe the issue with mutual_info* that the author of #28793 had broad up, can be resolved by re-naming (deprecation needed) the param to reflect its usage. Does that make sense?

At the same time, having copy, copy_x and copy_X terms explained in the glossary is a good idea. We could do both.

I think it's better to change copy_x and copy_X to copy and keep one term copy in the Glossary. For me three different terms for the same concept are quite redundant. What do you think @StefanieSenger ?

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.

Unexpected behavior of sklearn.feature_selection.mutual_info_regression if copy=False
2 participants