search

laito / cleartk

Automatically exported from code.google.com/p/cleartk
0 stars 0 forks source link

Revise package names #388

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
It seems there's at least one package name that doesn't match its module name:

org.cleartk.syntax.dependency.malt should be org.cleartk.maltparser

There may be more of these. We should fix them before the 2.0 release.

Original issue reported on code.google.com by steven.b...@gmail.com on 26 Oct 2013 at 12:13

GoogleCodeExporter commented 9 years ago

Original comment by steven.b...@gmail.com on 26 Oct 2013 at 12:13

GoogleCodeExporter commented 9 years ago 
All of the cleartk-ml modules violate this rule.  If we were strict about it, 
then org.cleartk.classifier would be org.cleartk.ml.  Same goes for the other 
cleartk-ml-* projects.  I think org.cleartk.ml is probably a better name too.  
Do you think we should change it?

Here are the other modules whose names do not strictly map to the package names:
cleartk-berkeley, cleartk-opennlp-tools, cleartk-snowball, 
cleartk-stanford-corenlp, and cleartk-test-util.  That's 5 plus the maltparser 
mentioned above plus 9 cleartk-ml modules for a grand total of 15 modules that 
don't conform to this rule.  There are around 25 modules that contain java code 
which means a pretty significant majority of our code isn't following this 
standard.  Were you thinking we would change all of these?  Seems like a lot of 
work.

Original comment by phi...@ogren.info on 9 Dec 2013 at 4:16

GoogleCodeExporter commented 9 years ago 
It's quite easy for us to rename packages in Eclipse, so I assume you mean 
"seems like a lot of work [for users]".

I guess the question is how much we care about naming and consistency. For me, 
I think the predictability of a package name matching the module name is pretty 
helpful. It allows you, for example, to look at someone else's code and 
immediately figure out which Maven modules you need to add as dependencies.

We're also breaking several things in cleartk-ml and other places, e.g. with 
our fixing of the CamelCase, and that's at least as much of a pain to fix as a 
package name change.

Original comment by steven.b...@gmail.com on 9 Dec 2013 at 4:25

GoogleCodeExporter commented 9 years ago 
It's fine by me!  I like naming consistency too.  I'm not saying it's a ton of 
work but the scope is certainly larger than the initial description suggests.

Original comment by phi...@ogren.info on 9 Dec 2013 at 4:46

GoogleCodeExporter commented 9 years ago

Original comment by phi...@ogren.info on 15 Mar 2014 at 6:28

GoogleCodeExporter commented 9 years ago 
I think I went through all the projects pretty carefully and think I got most 
of the changes made.  If there are any remaining inconsistencies, then we can 
file separate issues.  I made a few minor, mostly unrelated edits along the way 
- all mentioned in the commit comments

Original comment by phi...@ogren.info on 30 Mar 2014 at 2:54