You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@lucene.apache.org by GitBox <gi...@apache.org> on 2022/04/11 13:59:53 UTC
[GitHub] [lucene] rbowen opened a new pull request, #807: LUCENE-10512: Grammar: Remove incidents of "the the" in comments.
rbowen opened a new pull request, #807:
URL: https://github.com/apache/lucene/pull/807
# Description
Identify and fix "the the" repeated words in comments/docs.
# Solution
Purely cosmetic/grammar: Remove/replace "the the" in comments, documentation.
# Tests
No tests, because no functional change.
# Checklist
Please review the following and check all that apply:
- [ x] I have reviewed the guidelines for [How to Contribute](https://github.com/apache/lucene/blob/main/CONTRIBUTING.md) and my code conforms to the standards described there to the best of my ability.
- [x ] I have created a Jira issue and added the issue ID to my pull request title.
- [x ] I have given Lucene maintainers [access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to contribute to my PR branch. (optional but recommended)
- [ x] I have developed this patch against the `main` branch.
- [ x] I have run `./gradlew check`.
- [ ] I have added tests for my changes. (No: This makes no functional change)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] mikemccand merged pull request #807: LUCENE-10512: Grammar: Remove incidents of "the the" in comments.
Posted by GitBox <gi...@apache.org>.
mikemccand merged PR #807:
URL: https://github.com/apache/lucene/pull/807
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] uschindler commented on pull request #807: LUCENE-10512: Grammar: Remove incidents of "the the" in comments.
Posted by GitBox <gi...@apache.org>.
uschindler commented on PR #807:
URL: https://github.com/apache/lucene/pull/807#issuecomment-1096665479
Tidy is the best task name for this!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] mikemccand commented on pull request #807: LUCENE-10512: Grammar: Remove incidents of "the the" in comments.
Posted by GitBox <gi...@apache.org>.
mikemccand commented on PR #807:
URL: https://github.com/apache/lucene/pull/807#issuecomment-1101434176
> bq. Since the Spotless check seems to be fail-fast, maybe we should fix the exception message to just suggest ./gradlew tidy instead?
>
> Gradle runs tasks in parallel so it's not really "fail fast". It's "abort anything not yet started because built will fail". And if multiple things fail, gradle will report all of them (as a list of problems). As any tool, it takes some getting used to - I think these messages are quite fine (and 'tidy' is in fact a non-standard invention of mine... but it's a four letter word so I couldn't resist).
Well then I stand by my original fail-fast label LOL ;)
Concurrency of the tasks is no excuse. It is a complex build implementation detail, which you obviously deeply understand!! (thank you!!!!! I know migrating to `gradle` was an insane amount of work), that a new person should not need to know, or even know they don't know. From the fresh eyes user's standpoint, it still means that `./gradlew` is not showing all the things wrong with your change.
Clearly it confused fresh-eyes here -- look at the commit message above [It keeps finding new things ... what's up with this?](https://github.com/apache/lucene/pull/807/commits/79b3f722392c2bdccadc442ac6a2c09fc9727c58).
If we insist on our new users knowing these complex build implementation details then the least we could do is fix the exception message to say `just run ./gradlew check` or `./gradlew tidy`. Otherwise this trap remains for the next fresh eyes?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] rmuir commented on pull request #807: LUCENE-10512: Grammar: Remove incidents of "the the" in comments.
Posted by GitBox <gi...@apache.org>.
rmuir commented on PR #807:
URL: https://github.com/apache/lucene/pull/807#issuecomment-1103079108
> I don't know, Mike... Gradle doesn't seem like a tool that you can ever make dead-simple (like ant). I like what Robert added but with hacks like that a question always pops to my mind of what happens in gradle, internally, if you throw an exception from such a block - think throwing an exception from java's try-finally that obscures the original cause...
I first tried simply "printing stuff" (not throwing exception). in that case you see my "print" before the actual spotless exception text. So I changed it to `throw new GradleException` only because it would print my text after the spotless exception. If the concern is throwing the exception, maybe we could just print stuff. If we added more ascii art around it, it could still work :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] rmuir commented on pull request #807: LUCENE-10512: Grammar: Remove incidents of "the the" in comments.
Posted by GitBox <gi...@apache.org>.
rmuir commented on PR #807:
URL: https://github.com/apache/lucene/pull/807#issuecomment-1095141887
> You should be able to re-style your code automatically by running `./gradlew :lucene:core:spotlessApply`
Personally I would not recommend running it this way. I run `./gradlew tidy`, across the entire codebase/modules. It doesn't take too long and has never given me a problem.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] mikemccand commented on pull request #807: LUCENE-10512: Grammar: Remove incidents of "the the" in comments.
Posted by GitBox <gi...@apache.org>.
mikemccand commented on PR #807:
URL: https://github.com/apache/lucene/pull/807#issuecomment-1095111189
That CI build failure is a code styling issue. Lucene uses a [strict code-styling plugin called Spotless](https://issues.apache.org/jira/browse/LUCENE-9564), which removes all ambiguity and demands precise adherence, which is awesome (no more flame wars about whitespace). You should be able to re-style your code automatically by running `./gradlew :lucene:core:spotlessApply`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] dweiss commented on pull request #807: LUCENE-10512: Grammar: Remove incidents of "the the" in comments.
Posted by GitBox <gi...@apache.org>.
dweiss commented on PR #807:
URL: https://github.com/apache/lucene/pull/807#issuecomment-1102961503
I don't know, Mike... Gradle doesn't seem like a tool that you can ever make dead-simple (like ant). I like what Robert added but with hacks like that a question always pops to my mind of what happens in gradle, internally, if you throw an exception from such a block - think throwing an exception from java's try-finally that obscures the original cause...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] rmuir commented on pull request #807: LUCENE-10512: Grammar: Remove incidents of "the the" in comments.
Posted by GitBox <gi...@apache.org>.
rmuir commented on PR #807:
URL: https://github.com/apache/lucene/pull/807#issuecomment-1101498697
> bq. Since the Spotless check seems to be fail-fast, maybe we should fix the exception message to just suggest ./gradlew tidy instead?
I have a hacky patch: https://github.com/apache/lucene/pull/817
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] mikemccand commented on pull request #807: LUCENE-10512: Grammar: Remove incidents of "the the" in comments.
Posted by GitBox <gi...@apache.org>.
mikemccand commented on PR #807:
URL: https://github.com/apache/lucene/pull/807#issuecomment-1095108824
Whoa, thanks @rbowen for the attention to detail! This reminds me of the world's hardest band for search engines to find: [The The](https://en.wikipedia.org/wiki/The_The).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] dweiss commented on pull request #807: LUCENE-10512: Grammar: Remove incidents of "the the" in comments.
Posted by GitBox <gi...@apache.org>.
dweiss commented on PR #807:
URL: https://github.com/apache/lucene/pull/807#issuecomment-1095199898
bq. Since the Spotless check seems to be fail-fast, maybe we should fix the exception message to just suggest ./gradlew tidy instead?
Gradle runs tasks in parallel so it's not really "fail fast". It's "abort anything not yet started because built will fail". And if multiple things fail, gradle will report all of them (as a list of problems). As any tool, it takes some getting used to - I think these messages are quite fine (and 'tidy' is in fact a non-standard invention of mine... but it's a four letter word so I couldn't resist).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] mikemccand commented on pull request #807: LUCENE-10512: Grammar: Remove incidents of "the the" in comments.
Posted by GitBox <gi...@apache.org>.
mikemccand commented on PR #807:
URL: https://github.com/apache/lucene/pull/807#issuecomment-1095144308
> > You should be able to re-style your code automatically by running `./gradlew :lucene:core:spotlessApply`
>
> Personally I would not recommend running it this way. I run `./gradlew tidy`, across the entire codebase/modules. It doesn't take too long and has never given me a problem.
+1
Sorry, the command I suggested only fixes styling for `lucene/core`. @rmuir's command will fix ALL styling issues across ALL modules.
Since the Spotless check seems to be fail-fast, maybe we should fix the exception message to just suggest `./gradlew tidy` instead?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org