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

[gelly][Refactoring] Removed example string #625

Closed
wants to merge 2 commits into from

Conversation

andralungu
Copy link
Contributor

@vasia,

Just FYI :), in example/utils we have a class EdgeWithLongIdNullValueParser that is never used.

The examples that correspond to the library methods, e.g. PageRankExample cannot be renamed because that will cause a collision with the method name, in this case, PageRank. I guess that's why we added "Example" to the class name in the first place.

To me the examples look good as they are in this commit. If you have another idea for the library method examples, let me know, but in my view Example is better than Usage, or whatever different word we may come up with.

@andralungu
Copy link
Contributor Author

@vasia
Don't forget to also have a look at this PR. It's rebased :)

@vasia
Copy link
Contributor

vasia commented May 15, 2015

Hi @andralungu,

regarding EdgeWithLongIdNullValueParser: good catch, let's remove it then.

As for the renaming, I would like the examples naming to be consistent. Right now, we have some named xyzExample like GSAConnectedComponentsExample and others without "Example" in the end, like GSAPageRank. I personally don't like "Example" in the end, because it makes class names unnecessarily long (we already know they're examples since they're in the respective package).
For the ones that don't use a library method, this is no problem. For the ones that use a library method and we have a collision. I guess we have two choices: (a) keep the word "Example" for the ones using a library method or (b) renaming the library methods to something like xzyAlgorithm.

Any other ideas?

@andralungu
Copy link
Contributor Author

If you don't like the example string at the end, then we can go for sol (b)

@andralungu
Copy link
Contributor Author

PR updated.

@vasia
Copy link
Contributor

vasia commented May 19, 2015

I take it your update means you agreed with my suggestion :)
I'll merge this one as well!

@asfgit asfgit closed this in 8f4039d May 19, 2015
marthavk pushed a commit to marthavk/flink that referenced this pull request Jun 9, 2015
Added Algorithm end string to the library methods

This closes apache#625
nltran pushed a commit to nltran/flink that referenced this pull request Jan 8, 2016
Added Algorithm end string to the library methods

This closes apache#625
pnowojski pushed a commit to pnowojski/flink that referenced this pull request Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants