[
https://issues.apache.org/jira/browse/OPENNLP-1404?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17643041#comment-17643041
]
ASF GitHub Bot commented on OPENNLP-1404:
-----------------------------------------
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! :)
> Enhance JavaDoc in opennlp.tools.postag package
> -----------------------------------------------
>
> Key: OPENNLP-1404
> URL: https://issues.apache.org/jira/browse/OPENNLP-1404
> Project: OpenNLP
> Issue Type: Improvement
> Components: Documentation, POS Tagger
> Affects Versions: 2.1.0
> Reporter: Martin Wiesner
> Priority: Minor
> Fix For: 2.1.1
>
>
> The JavaDoc of the _opennlp.tools.postag_ package suffers from several
> inconsistencies and missing descriptions. Moreover, several typos are present
> that need sanitizing.
> It needs enhancements and/or additions to provide more clarity for readers of
> this part of the OpenNLP API.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
