[
https://issues.apache.org/jira/browse/LUCENE-9570?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17258944#comment-17258944
]
Erick Erickson commented on LUCENE-9570:
----------------------------------------
Wheeeee! Lucene is done! Now when we figure out what's up with the reference
impl we'll get to tackle Solr.
I also followed the path Dawid did. For instance, I only changed if statements
that didn't have braces if they'd been changed by the formatting, didn't try to
deal with ones with the single-line body on the same line as the if that the
formatter didn't touch.
So some of the Javadocs are a little wonky I'm sure, although the output they
_produce_ ought to be reasonable. Once we have the process in place, we will at
least not introduce _more_ differently-formatted code and wonkiness can be
cleaned up as necessary.
Many thanks [~dweiss] for making this happen!
> 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
> Fix For: master (9.0)
>
> Time Spent: 0.5h
> 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}
--
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
