Skip to content

Conversation

@aditya1702
Copy link

What changes were proposed in this pull request?

It seems that just like in Scala/Java there is inconsistency in the Python API too at some places,

Note:
NOTE:
Note that
'''Note:'''
@note
This PR proposes to fix those to @note to be consistent.

How was this patch tested?

This was tested by searching in the editor for versions of "NOTE" in the python APIs and then fixing them to become consistence.

This PR is a sub-extension of #15889

@aditya1702
Copy link
Author

@HyukjinKwon Could you review?

@AmplabJenkins
Copy link

Can one of the admins verify this patch?

@rxin
Copy link
Contributor

rxin commented Nov 19, 2016

I don't think any of these actually matter, because these functions are not public documentations.

@HyukjinKwon
Copy link
Member

Yes, you should check if they are exposed in the API documentation. I intentionally updated only those ones before.

@HyukjinKwon
Copy link
Member

Ah, @aditya1702, I assume, from the title, you meant to do this for Python documentation. Actually, the PR you pointed out deals with all of Scala/Java documentation if I haven’t missed some. Maybe, .. note: in Python codes should be handled for Python API documentation including some images from manually built API documentation in the PR. If you are not sure of what to fix, I can take over this and cc you in the PR. I guess you could close this PR meanwhile.

@aditya1702
Copy link
Author

@HyukjinKwon @rxin Yes I think I got confused as pointed out by Hyukjin above 😅 . @HyukjinKwon you can take this one over and cc me. I will work on another issue. Sorry for the troubles

@aditya1702 aditya1702 closed this Nov 20, 2016
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