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

Names of functions inconsistent and against conventions #2

Open
jaksmid opened this issue Feb 23, 2015 · 0 comments
Open

Names of functions inconsistent and against conventions #2

jaksmid opened this issue Feb 23, 2015 · 0 comments
Assignees

Comments

@jaksmid
Copy link
Contributor

jaksmid commented Feb 23, 2015

OpenmlConnector:
Almost all methods starts with openMl. This is generally not recommended as it should be clear from the object type itself what it is upload.
It would be like class person would have methods like getPersonName.

Method also usually start with nout and then verb.
e.g. dataUpload. This could lead to thinking that you are creating some sort of precooked dataupload object (especially when the return data type is called DataUpload).
It is usually recommended to start with verb first, e.g. uploadData.
It would be also consistent with some other methods in the class that starts with verb.

There are multiple ways to go, we could break the API or we could stuill support the old api and mark the old methods as obsolete.
Ref: http://www.iwombat.com/standards/JavaStyleGuide.html

@jaksmid jaksmid self-assigned this Feb 23, 2015
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

No branches or pull requests

1 participant