[jira] [Comment Edited] (LUCENE-9570) Review code diffs after automatic formatting and correct problems before it is applied

["Dawid Weiss (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/LUCENE-9570?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17258436#comment-17258436 ] 

Dawid Weiss edited comment on LUCENE-9570 at 1/4/21, 7:19 PM:
--------------------------------------------------------------

ECJ bug discovered. This javadoc:
{code}
 * <p>You can avoid specific names {@link Class#getSimpleName()} or use the special value {@code
 * *} to disable all mock filesystems.
{code}

causes ECJ failure:
{code}
1. ERROR in C:\Work\apache\lucene.master\lucene\test-framework\src\java\org\apache\lucene\util\LuceneTestCase.java (at line 303)
        * <p>You can avoid specific names {@link Class#getSimpleName()} or use the special value {@code
                                                                                                   ^^^^
Javadoc: Description expected after @code
{code}


was (Author: dweiss):
ECJ bug discovered. This javadoc:
{code}
 * <p>You can avoid specific names {@link Class#getSimpleName()} or use the special value {@code
 * *} to disable all mock filesystems.
{code}

causes ECJ failure:
{code}
1. ERROR in C:\Work\apache\lucene.master\lucene\test-framework\src\java\org\apache\lucene\util\LuceneTestCase.java (at line 303)
        * <p>You can avoid specific names {@@link Class#getSimpleName()} or use the special value {@code
                                                                                                   ^^^^
Javadoc: Description expected after @@code
{code}

> Review code diffs after automatic formatting and correct problems before it is applied
> --------------------------------------------------------------------------------------
>
>                 Key: LUCENE-9570
>                 URL: https://issues.apache.org/jira/browse/LUCENE-9570
>             Project: Lucene - Core
>          Issue Type: Sub-task
>            Reporter: Dawid Weiss
>            Assignee: Dawid Weiss
>            Priority: Blocker
>          Time Spent: 10m
>  Remaining Estimate: 0h
>
> Review and correct all the javadocs before they're messed up by automatic formatting. Apply project-by-project, review diff, correct. Lots of diffs but it should be relatively quick.
> *Reviewing diffs manually*
>  * switch to branch jira/LUCENE-9570 which the PR is based on:
> {code:java}
> git remote add dweiss git@github.com:dweiss/lucene-solr.git
> git fetch dweiss
> git checkout jira/LUCENE-9570
> {code}
>  * Open gradle/validation/spotless.gradle and locate the project/ package you wish to review. Enable it in spotless.gradle by creating a corresponding switch case block (refer to existing examples), for example:
> {code:java}
>           case ":lucene:highlighter":
>             target "src/**"
>             targetExclude "**/resources/**", "**/overview.html"
>             break
> {code}
>  * Reformat the code:
> {code:java}
> gradlew tidy && git diff -w > /tmp/diff.patch && git status
> {code}
>  * Look at what has changed (git status) and review the differences manually (/tmp/diff.patch). If everything looks ok, commit it directly to jira/LUCENE-9570 or make a PR against that branch.
> {code:java}
> git commit -am ":lucene:core - src/**/org/apache/lucene/document/**"
> {code}
> *Packages remaining* (put your name next to a module you're working on to avoid duplication).
>  * case ":lucene:luke": (Erick Erickson)
>  * case ":lucene:spatial3d": (Bruno Roustant)
>  * case ":lucene:spatial-extras":



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org