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

Bruno Roustant commented on LUCENE-9570:
----------------------------------------

[~dweiss] Yes finally it's done. I pushed the commit directly to your branch.

I have been working on spatial3d since yesterday. 123 classes, with some giant 
ones. Ouch, it took me more time than anticipated.

Lots of (inconsistently) missing braces in a single-line if. I added them. I 
hope I didn't miss too many of them.

Many multi-line comments where the lines where truncated with a newline 
inserted. I had to reformat manually the comment.

Badly formatted commented code. Either line-truncated, or with original 
commented code had no space between concatenated strings (and I tried to add 
them as often as I could)

Lots of duplicated code to reformat again and again.

 

> 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: 20m
>  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 g...@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:spatial3d": (Bruno Roustant)



--
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

Reply via email to