[GitHub] [opennlp] rzo1 commented on a diff in pull request #446: OPENNLP-1404 Enhance JavaDoc in opennlp.tools.postag package

[GitBox <gi...@apache.org>]

rzo1 commented on code in PR #446:
URL: https://github.com/apache/opennlp/pull/446#discussion_r1038998936


##########
opennlp-tools/src/main/java/opennlp/tools/postag/POSTaggerFactory.java:
##########
@@ -363,11 +382,11 @@ public void validateArtifactMap() throws InvalidFormatException {
     if (ngramDictEntry != null && !(ngramDictEntry instanceof Dictionary)) {
       throw new InvalidFormatException("NGram dictionary has wrong type!");
     }
-
   }
 
+  // reduced visibility to ensure deprecation is respected in future versions
   @Deprecated

Review Comment:
   > +1 to having it well documented so devs/committers are aware of what can be done or not.
   
   +1 -  we need some clear guideance / documentation. People need to know what to expect if they are using deprecated things. Judging from the cleanup process, we deprecated things (e.g. via a Javadoc comment) but never get down the road to actually cleanup or remove them ;-)
   
   > Sure. IMHO, it's important to define under which circumstances deprecation is tolerable, or in other words how to evolve an API. I've seen spots in the OpenNLP code where only a JavaDoc comment signals deprecation, so the compiler wouldn't warn devs (external or "homies").
   
   I am +1 with @mawiesne  - the best thing would be, that we find some consent on how to deal with deprecated things between releases and document it, so we have some written consent, which isn't forgotten or only in the "heads" :-)
   
   That said, I really appreciate @mawiesne effort to increase the readability & clarity of the code! :)



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@opennlp.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org