-
Notifications
You must be signed in to change notification settings - Fork 28.9k
[SPARK-10778][MLlib]Implement toString for AssociationRules.Rule #8904
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
Conversation
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.
Trivial, but you should use @return and there's no need to state the return type again. Remove the blank line below too
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.
@srowen
Thank you for review.
I fixed.
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.
Actually, I think Returns is better than @return. If we use @return, the message doesn't show up by default in the API doc, e.g.,
User needs to open it to see the doc:
If we use Returns, it shows up by default:
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.
Sure, I don't feel strongly about it. Wouldn't this argument go for all return docs though? They're hidden by default for brevity. Maybe important ones should be put inline in the main doc but toString seems pretty minor.
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.
For each method, there should be a summary sentence at the beginning, which shows up in the API doc by default. Other details are hidden by default. I think this is Scala specific. You can find the official guide at http://docs.scala-lang.org/style/scaladoc.html:
If the documentation of a method is a one line description of
what that method returns, do not repeat it with an @return annotation.
|
@mengxr I fixed format. So, which should I use, |
|
|
|
@mengxr I fixed. |
|
Test build #1815 has finished for PR 8904 at commit
|
|
We still need a return type on the method, and the line is too long and needs to be wrapped |
|
@srowen I fixed. |
|
Test build #1816 has finished for PR 8904 at commit
|
|
Test build #1817 has finished for PR 8904 at commit
|
|
Test build #1819 has finished for PR 8904 at commit
|
|
Merged to master |



I implemented toString for AssociationRules.Rule, format like
[x, y] => {z}: 1.0