[
https://issues.apache.org/jira/browse/OPENNLP-1404?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17643024#comment-17643024
]
ASF GitHub Bot commented on OPENNLP-1404:
-----------------------------------------
mawiesne commented on code in PR #446:
URL: https://github.com/apache/opennlp/pull/446#discussion_r1038989984
##########
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:
I've been thinking around at this line for a while. There are so many places
that are deprecated _and_ unused. Worth documenting things that are both? Or
remove or change the visibility so future releases mildly convince users to
change their own code and to drop deprecated stuff that has been in this state
for (many,) many years.
Agreed that we need a policy on how to clean up or handle (internally
unused!) Deprecated things.
Same applies for all other spots I felt an adjustment makes sense.
> 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)