[
https://issues.apache.org/jira/browse/LUCENE-9570?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Erick Erickson 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 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:analysis:common": (partially done, dweiss)
* case ":lucene:analysis:icu":
* case ":lucene:analysis:kuromoji":
* case ":lucene:analysis:morfologik":
* case ":lucene:analysis:nori":
* case ":lucene:analysis:opennlp":
* case ":lucene:analysis:phonetic":
* case ":lucene:analysis:smartcn":
* case ":lucene:analysis:stempel":
* case ":lucene:backward-codecs":
* case ":lucene:benchmark":
* case ":lucene:classification":
* case ":lucene:codecs":
* case ":lucene:demo":
* case ":lucene:expressions":
* case ":lucene:facet": (Erick Erickson)
* case ":lucene:grouping":
* case ":lucene:join":
* case ":lucene:luke":
* case ":lucene:memory":
* case ":lucene:misc":
* case ":lucene:monitor":
* case ":lucene:queries": (Erick Erickson - done)
* case ":lucene:queryparser":
* case ":lucene:replicator":
* case ":lucene:sandbox":
* case ":lucene:spatial3d":
* case ":lucene:spatial-extras":
* case ":lucene:suggest":
* case ":lucene:test-framework":
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.
*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:analysis:common": (partially done, dweiss)
* case ":lucene:analysis:icu":
* case ":lucene:analysis:kuromoji":
* case ":lucene:analysis:morfologik":
* case ":lucene:analysis:nori":
* case ":lucene:analysis:opennlp":
* case ":lucene:analysis:phonetic":
* case ":lucene:analysis:smartcn":
* case ":lucene:analysis:stempel":
* case ":lucene:backward-codecs":
* case ":lucene:benchmark":
* case ":lucene:classification":
* case ":lucene:codecs":
* case ":lucene:demo":
* case ":lucene:expressions":
* case ":lucene:facet":
* case ":lucene:grouping":
* case ":lucene:join":
* case ":lucene:luke":
* case ":lucene:memory":
* case ":lucene:misc":
* case ":lucene:monitor":
* case ":lucene:queries": (Erick Erickson)
* case ":lucene:queryparser":
* case ":lucene:replicator":
* case ":lucene:sandbox":
* case ":lucene:spatial3d":
* case ":lucene:spatial-extras":
* case ":lucene:suggest":
* case ":lucene:test-framework":
> 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 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:analysis:common": (partially done, dweiss)
> * case ":lucene:analysis:icu":
> * case ":lucene:analysis:kuromoji":
> * case ":lucene:analysis:morfologik":
> * case ":lucene:analysis:nori":
> * case ":lucene:analysis:opennlp":
> * case ":lucene:analysis:phonetic":
> * case ":lucene:analysis:smartcn":
> * case ":lucene:analysis:stempel":
> * case ":lucene:backward-codecs":
> * case ":lucene:benchmark":
> * case ":lucene:classification":
> * case ":lucene:codecs":
> * case ":lucene:demo":
> * case ":lucene:expressions":
> * case ":lucene:facet": (Erick Erickson)
> * case ":lucene:grouping":
> * case ":lucene:join":
> * case ":lucene:luke":
> * case ":lucene:memory":
> * case ":lucene:misc":
> * case ":lucene:monitor":
> * case ":lucene:queries": (Erick Erickson - done)
> * case ":lucene:queryparser":
> * case ":lucene:replicator":
> * case ":lucene:sandbox":
> * case ":lucene:spatial3d":
> * case ":lucene:spatial-extras":
> * case ":lucene:suggest":
> * case ":lucene:test-framework":
--
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
