epotyom commented on PR #12025: URL: https://github.com/apache/lucene/pull/12025#issuecomment-1361631708
> 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 There is a check that referenced `region`s exist in the source file. And the regions support is the only benefit really compared to links to source code as in your IndexFiles/SearchFiles example, because you don't need to scroll through source files to find an example referenced. But it's true that it doesn't beat disadvantages that you listed. Updated the pull request to link to source files instead of using snippets. -- 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: issues-unsubscr...@lucene.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For additional commands, e-mail: issues-h...@lucene.apache.org
