[
https://issues.apache.org/jira/browse/LUCENE-9201?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17042976#comment-17042976
]
Tomoko Uchida commented on LUCENE-9201:
---------------------------------------
I attached [^LUCENE-9201-missing-docs.patch], where the only difference to
[^LUCENE-9201.patch] is this line.
{code:java}
< + dirs.each { dir ->
---
> + dirs.findAll { it.exists() }.each { dir ->
{code}
(I'm not so familiar with groovy though, collect() seems not to be a filter but
a mapper or iterator.
[http://docs.groovy-lang.org/next/html/documentation/working-with-collections.html#_iterating_on_a_list])
{quote}The task as it is now doesn't really pass for me (python script fails
for certain subprojects)? This is expected, right?
{quote}
Yes, this is expected. Some projects (lucene/backward-codecs,
lucene/queryparser, etc.) have legacy package.html file in their source but
Gradle Javadoc task ignores them, so the generated Javadocs lack package
summary. The python linter detects that and correctly fails for now. This is
the reason why I disabled this task for precommit:
[https://github.com/apache/lucene-solr/pull/1267/files#diff-5a33a39a6ec8b4facbd4db4cdfb4131a].
We have to fix Javadoc task (another issue may be needed?), to make the linter
happy. I think is is fine that we have the "missing docs check" task on the
master soon, to track how the javadoc task is broken or fixed.
I'd like to commit it to the master tomorrow if there is no disapproval, since
it's a bit late on JST...
> Port documentation-lint task to Gradle build
> --------------------------------------------
>
> Key: LUCENE-9201
> URL: https://issues.apache.org/jira/browse/LUCENE-9201
> Project: Lucene - Core
> Issue Type: Sub-task
> Affects Versions: master (9.0)
> Reporter: Tomoko Uchida
> Assignee: Tomoko Uchida
> Priority: Major
> Attachments: LUCENE-9201-ecj-2.patch, LUCENE-9201-ecj.patch,
> LUCENE-9201-missing-docs.patch, LUCENE-9201.patch, javadocGRADLE.png,
> javadocHTML4.png, javadocHTML5.png
>
> Time Spent: 4h 10m
> Remaining Estimate: 0h
>
> Ant build's "documentation-lint" target consists of those two sub targets.
> * "-ecj-javadoc-lint" (Javadoc linting by ECJ)
> * "-documentation-lint"(Missing javadocs / broken links check by python
> scripts)
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
