You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by Erick Erickson <er...@gmail.com> on 2018/04/13 00:50:37 UTC
Precommit failures
I'm getting this precommit failure on a fresh clone of master:
-documentation-lint:
[echo] checking for broken html...
[jtidy] Checking for broken html (such as invalid tags)...
[delete] Deleting directory
/Users/Erick/apache/solrVersions/solr-12028/lucene/build/jtidy_tmp
[echo] Checking for broken links...
[exec]
[exec] Crawl/parse...
[exec]
[exec] Verify...
[echo] Checking for missing docs...
[exec]
[exec] build/docs/spatial3d/org/apache/lucene/spatial3d/geom/SidedPlane.html
[exec] missing Methods: strictlyWithin-double-double-double-
[exec] missing Methods:
strictlyWithin-org.apache.lucene.spatial3d.geom.Vector-
[exec]
[exec] Missing javadocs were found!
Anyone have a clue? I don't see Jenkins failures for this so maybe
it's just me somehow.
Erick
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
Re: Precommit failures
Posted by Erick Erickson <er...@gmail.com>.
Thanks all!
On Thu, Apr 12, 2018 at 8:28 PM, Karl Wright <da...@gmail.com> wrote:
> I've been having inconsistent runs of precommit. Sometimes it complains,
> sometimes not. But easily fixed -- I'll push javadoc now.
>
> Karl
>
> On Thu, Apr 12, 2018 at 8:50 PM, Erick Erickson <er...@gmail.com>
> wrote:
>>
>> I'm getting this precommit failure on a fresh clone of master:
>>
>> -documentation-lint:
>>
>> [echo] checking for broken html...
>>
>> [jtidy] Checking for broken html (such as invalid tags)...
>>
>> [delete] Deleting directory
>> /Users/Erick/apache/solrVersions/solr-12028/lucene/build/jtidy_tmp
>> [echo] Checking for broken links...
>> [exec]
>> [exec] Crawl/parse...
>> [exec]
>> [exec] Verify...
>> [echo] Checking for missing docs...
>> [exec]
>> [exec]
>> build/docs/spatial3d/org/apache/lucene/spatial3d/geom/SidedPlane.html
>> [exec] missing Methods: strictlyWithin-double-double-double-
>> [exec] missing Methods:
>> strictlyWithin-org.apache.lucene.spatial3d.geom.Vector-
>> [exec]
>> [exec] Missing javadocs were found!
>>
>> Anyone have a clue? I don't see Jenkins failures for this so maybe
>> it's just me somehow.
>>
>> Erick
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
>> For additional commands, e-mail: dev-help@lucene.apache.org
>>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
Re: Precommit failures
Posted by Karl Wright <da...@gmail.com>.
I've been having inconsistent runs of precommit. Sometimes it complains,
sometimes not. But easily fixed -- I'll push javadoc now.
Karl
On Thu, Apr 12, 2018 at 8:50 PM, Erick Erickson <er...@gmail.com>
wrote:
> I'm getting this precommit failure on a fresh clone of master:
>
> -documentation-lint:
>
> [echo] checking for broken html...
>
> [jtidy] Checking for broken html (such as invalid tags)...
>
> [delete] Deleting directory
> /Users/Erick/apache/solrVersions/solr-12028/lucene/build/jtidy_tmp
> [echo] Checking for broken links...
> [exec]
> [exec] Crawl/parse...
> [exec]
> [exec] Verify...
> [echo] Checking for missing docs...
> [exec]
> [exec] build/docs/spatial3d/org/apache/lucene/spatial3d/geom/
> SidedPlane.html
> [exec] missing Methods: strictlyWithin-double-double-double-
> [exec] missing Methods:
> strictlyWithin-org.apache.lucene.spatial3d.geom.Vector-
> [exec]
> [exec] Missing javadocs were found!
>
> Anyone have a clue? I don't see Jenkins failures for this so maybe
> it's just me somehow.
>
> Erick
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
> For additional commands, e-mail: dev-help@lucene.apache.org
>
>
Re: Precommit failures
Posted by Shawn Heisey <ap...@elyograg.org>.
On 4/12/2018 8:56 PM, David Smiley wrote:
> It's happening to me too! I added a /** anything */ comment on these
> two methods and the warning went away. But we don't have rules about
> requiring comments on public methods (I thought)?
I thought the point of the javadoc check was to make sure that all
public methods *do* have javadocs, unless they're overriding a method in
a parent class/interface that already has javadoc. (IDEs will display
the parent javadoc in those cases)
I find it frustrating when I'm using a public API in a library and it's
not documented to show how it can be used. While it's true that good
choices for all the class/method/parameter names can sometimes make the
exposed API self-documenting, often the usage is just too complex for
that, or has gotchas that require explanation.
Probably a good idea for all public fields to have javadoc as well, but
I wouldn't expect that to be a requirement.If javadoc on "protected"
items is published, then I think those should require javadoc too, so
someone extending the class will know what those things do.
Thanks,
Shawn
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org
Re: Precommit failures
Posted by David Smiley <da...@gmail.com>.
It's happening to me too! I added a /** anything */ comment on these two
methods and the warning went away. But we don't have rules about requiring
comments on public methods (I thought)?
On Thu, Apr 12, 2018 at 8:51 PM Erick Erickson <er...@gmail.com>
wrote:
> I'm getting this precommit failure on a fresh clone of master:
>
> -documentation-lint:
>
> [echo] checking for broken html...
>
> [jtidy] Checking for broken html (such as invalid tags)...
>
> [delete] Deleting directory
> /Users/Erick/apache/solrVersions/solr-12028/lucene/build/jtidy_tmp
> [echo] Checking for broken links...
> [exec]
> [exec] Crawl/parse...
> [exec]
> [exec] Verify...
> [echo] Checking for missing docs...
> [exec]
> [exec]
> build/docs/spatial3d/org/apache/lucene/spatial3d/geom/SidedPlane.html
> [exec] missing Methods: strictlyWithin-double-double-double-
> [exec] missing Methods:
> strictlyWithin-org.apache.lucene.spatial3d.geom.Vector-
> [exec]
> [exec] Missing javadocs were found!
>
> Anyone have a clue? I don't see Jenkins failures for this so maybe
> it's just me somehow.
>
> Erick
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
> For additional commands, e-mail: dev-help@lucene.apache.org
>
> --
Lucene/Solr Search Committer, Consultant, Developer, Author, Speaker
LinkedIn: http://linkedin.com/in/davidwsmiley | Book:
http://www.solrenterprisesearchserver.com