[
https://issues.apache.org/jira/browse/LUCENE-9570?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Dawid Weiss updated LUCENE-9570:
--------------------------------
Description:
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
* 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}
case ":lucene:highlighter":
target "src/**"
targetExclude "**/resources/**", "**/overview.html"
break
{code}
* Reformat the code:
{code}
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}
git commit -am ":lucene:core - src/**/org/apache/lucene/document/**"
{code}
was: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.
> 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
> * 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}
> case ":lucene:highlighter":
> target "src/**"
> targetExclude "**/resources/**", "**/overview.html"
> break
> {code}
> * Reformat the code:
> {code}
> 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}
> 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
