-
-
Notifications
You must be signed in to change notification settings - Fork 25.8k
DOC: AgglomerativeCluster Metric Keyword Documentation #29935
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: AgglomerativeCluster Metric Keyword Documentation #29935
Conversation
Further improves documentation for the Metric keyword.
@jeremiedbb or @glemaitre , requesting either give this a quick look and let me know if this pr is beneficial to the project. Goal is to deprecate affinity keyword as per the linked conversation. Edit: Conflicts Resolved. |
I went through the original issue. There is no need to change any code. The only thing that @Micky774 is mentioning is to document the fact that So there is no need to change any code in the private functions. |
Ok I misunderstood the assignment so, I thought the keyword |
Indeed, it already had been removed in a prior version of scikit-learn. Since the issue is old, at this time, the parameter was only deprecate and announced to be removed. So I agree that it is pretty confusing :) |
@glemaitre Ready for review. Most over the top PR for such a small change to docs ! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks @Sean-Jay-M
Reference Issues/PRs
#26961
This issue is on the maintenance board under moderate.
In the discussion it has been noted that the issue can be broken into three parts. This PR covers the following part:
it deprecates the keyword affinity and updates the documentation for the metrics keyword.Updates the documentation for the 'metric' keyword argument.What does this implement/fix? Explain your changes.
Deprecates affinity keyword, updates documentation and updates tests.Updates the documentation for the 'metric' keyword argument.
Additional Comments:
Will add to changelog in coming days.Changelog Added.