rmuir commented on PR #12025: URL: https://github.com/apache/lucene/pull/12025#issuecomment-1358049032
I'm not familiar enough with the new snippet support to know. I've only glanced at the JEP. It seemed interesting to me for these cases, but at the same time I don't understand the level of compile-time safety that they have. At the same time, for demo module we already have a method for compile-time safety of examples that doesn't rely upon this new `@snippet`. See IndexFiles/SearchFiles where we simply include the source code in the javadocs: https://lucene.apache.org/core/9_4_2/demo/index.html https://lucene.apache.org/core/9_4_2/demo/src-html/org/apache/lucene/demo/IndexFiles.html I'd say, if anything the `@snippet` might be something to defer to later. it would make it easier for me to integrate this change. Currently I wouldn't be happy about turning off ECJ checks on javadocs, passing hardcoded org.apache.lucene.demo stuff to every lucene module, generating radically different docs depending on JDK version, etc. It makes things a lot more complicated. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
