[
https://issues.apache.org/jira/browse/LUCENE-8481?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16604267#comment-16604267
]
Dawid Weiss commented on LUCENE-8481:
-------------------------------------
I honestly don't know if this patch should be applied at all; it clearly shows
that those snippets of code in the documentation go out of sync with the
codebase very quickly. Perhaps we should use some kind of snippet injection or
linking to keep the code "real" and not rely on manual updates.
That "TestDemo" class is not just out of sync with package documentation, it's
also odd and uses test randomization infrastructure, which is way beyond the
scope of a simple introductory example. There is also the "demo" module which
contains another "TestDemo", which only adds to the confusion.
> Javadocs should no longer reference RAMDirectory
> ------------------------------------------------
>
> Key: LUCENE-8481
> URL: https://issues.apache.org/jira/browse/LUCENE-8481
> Project: Lucene - Core
> Issue Type: Task
> Reporter: Adrien Grand
> Priority: Minor
> Attachments: LUCENE-8481.patch
>
>
> Since RAMDirectory is deprecated, we shouldn't show examples using it
> anymore. See eg.
> https://github.com/apache/lucene-solr/blob/a1ec716e107807f1dc24923cc7a91d0c5e64a7e1/lucene/core/src/java/overview.html#L36.
> cc [~dweiss]
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
