Skip to content

[WIP] added comments to tree splitter code #8779

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

Closed

Conversation

andreh7
Copy link
Contributor

@andreh7 andreh7 commented Apr 22, 2017

Reference Issue

Does not fix any issue but should help advance #3628 .

What does this implement/fix? Explain your changes.

No code changes, just adding comments to better understand
what the code in tree/_splitter.pyx does.

Any other comments?

I noticed that I made most of the comment additions only to the
first class (BestSplitter) and it looks like there is quite some code duplication.

If deemed useful, I can also add the same comment additions to the
other three splitter classes in tree/_splitter.pyx (hence this PR is marked as [WIP]).
On the other hand, if #3628 is going to be addressed soon, it may not be useful to
duplicate such comments.

@glemaitre
Copy link
Member

I am not convinced that we should add more comments. The code should self-document and additional comments can highlight some non-straightforward behavior, which seems the case for this code.

@jmschrei
Copy link
Member

I am also +0 for adding in more comments, in that I am not against them in general but don't see these are necessary.

@rth
Copy link
Member

rth commented Jul 3, 2019

Closing, as reviewers appeared unconvinced about adding more comments to that code, and there has been no activity here since 2017. Sorry, thanks for your contribution!

@rth rth closed this Jul 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants