You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@solr.apache.org by "AndreyBozhko (via GitHub)" <gi...@apache.org> on 2023/05/07 02:02:44 UTC
[GitHub] [solr] AndreyBozhko opened a new pull request, #1629: MINOR: Fix typos in `org.apache.solr.core` package
AndreyBozhko opened a new pull request, #1629:
URL: https://github.com/apache/solr/pull/1629
<!--
_(If you are a project committer then you may remove some/all of the following template.)_
Before creating a pull request, please file an issue in the ASF Jira system for Solr:
* https://issues.apache.org/jira/projects/SOLR
For something minor (i.e. that wouldn't be worth putting in release notes), you can skip JIRA.
To create a Jira issue, you will need to create an account there first.
The title of the PR should reference the Jira issue number in the form:
* SOLR-####: <short description of problem or changes>
SOLR must be fully capitalized. A short description helps people scanning pull requests for items they can work on.
Properly referencing the issue in the title ensures that Jira is correctly updated with code review comments and commits. -->
# Description
Fix a number of typos in `org.apache.solr.core` package - mostly in javadoc and comments.
# Checklist
Please review the following and check all that apply:
- [x] I have reviewed the guidelines for [How to Contribute](https://wiki.apache.org/solr/HowToContribute) and my code conforms to the standards described there to the best of my ability.
- [ ] I have created a Jira issue and added the issue ID to my pull request title.
- [x] I have given Solr 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.
- [ ] I have added documentation for the [Reference Guide](https://github.com/apache/solr/tree/main/solr/solr-ref-guide)
--
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@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] MarcusSorealheis merged pull request #1629: MINOR: Fix typos in `org.apache.solr.core` package
Posted by "MarcusSorealheis (via GitHub)" <gi...@apache.org>.
MarcusSorealheis merged PR #1629:
URL: https://github.com/apache/solr/pull/1629
--
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@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] MarcusSorealheis commented on a diff in pull request #1629: MINOR: Fix typos in `org.apache.solr.core` package
Posted by "MarcusSorealheis (via GitHub)" <gi...@apache.org>.
MarcusSorealheis commented on code in PR #1629:
URL: https://github.com/apache/solr/pull/1629#discussion_r1187022006
##########
solr/core/src/java/org/apache/solr/core/SolrCore.java:
##########
@@ -403,12 +403,12 @@ public String getIndexDir() {
/**
* Returns the indexdir as given in index.properties. If index.properties exists in dataDir and
- * there is a property <i>index</i> available and it points to a valid directory in dataDir that
+ * there is a property <i>index</i> available, and it points to a valid directory in dataDir that
* is returned. Else dataDir/index is returned. Only called for creating new indexSearchers and
* indexwriters. Use the getIndexDir() method to know the active index directory
*
* @return the indexdir as given in index.properties
- * @throws SolrException if for any reason the a reasonable index directory cannot be determined.
+ * @throws SolrException if for any reason a reasonable index directory cannot be determined.
Review Comment:
should this comment simply be:
`@throws SolrException if for any reason an index directory cannot be determined.`
##########
solr/core/src/java/org/apache/solr/core/backup/repository/BackupRepositoryFactory.java:
##########
@@ -78,7 +78,7 @@ public BackupRepository newInstance(SolrResourceLoader loader, String name) {
BackupRepository result = loader.newInstance(repo.className, BackupRepository.class);
if ("trackingBackupRepository".equals(name)) {
// newInstance can be called by multiple threads, synchronization prevents simultaneous
- // multi-threaded 'adds' from corrupting the namedlist
+ // multithreaded 'adds' from corrupting the namedlist
Review Comment:
echoing @janhoy, I appreciate the attention to detail.
While we are at it, do you think it would be too much to ask to change the mentions of `namedList` in the comments to follow their used convention, `namedList`? This change would be important for users searching the code base here with case sensitivity enabled, which is quite common.
--
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@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] HoustonPutman commented on pull request #1629: MINOR: Fix typos in `org.apache.solr.core` package
Posted by "HoustonPutman (via GitHub)" <gi...@apache.org>.
HoustonPutman commented on PR #1629:
URL: https://github.com/apache/solr/pull/1629#issuecomment-1624307885
I'll back port next week.
--
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@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] MarcusSorealheis commented on pull request #1629: MINOR: Fix typos in `org.apache.solr.core` package
Posted by "MarcusSorealheis (via GitHub)" <gi...@apache.org>.
MarcusSorealheis commented on PR #1629:
URL: https://github.com/apache/solr/pull/1629#issuecomment-1538721544
I pushed the changes up so I don't hold it up. @AndreyBozhko thanks for the contribution and I look forward to more in the future.
--
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@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] HoustonPutman commented on pull request #1629: MINOR: Fix typos in `org.apache.solr.core` package
Posted by "HoustonPutman (via GitHub)" <gi...@apache.org>.
HoustonPutman commented on PR #1629:
URL: https://github.com/apache/solr/pull/1629#issuecomment-1591402785
This should be backported to 9.3, no reason to keep it just for `main`.
--
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@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] AndreyBozhko commented on pull request #1629: MINOR: Fix typos in `org.apache.solr.core` package
Posted by "AndreyBozhko (via GitHub)" <gi...@apache.org>.
AndreyBozhko commented on PR #1629:
URL: https://github.com/apache/solr/pull/1629#issuecomment-1538922644
Thanks @MarcusSorealheis for the suggestion, I added a CHANGES entry.
--
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@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] AndreyBozhko commented on pull request #1629: MINOR: Fix typos in `org.apache.solr.core` package
Posted by "AndreyBozhko (via GitHub)" <gi...@apache.org>.
AndreyBozhko commented on PR #1629:
URL: https://github.com/apache/solr/pull/1629#issuecomment-1537714966
Thanks for the reviews - please feel free to merge this at your earliest convenience, as it seems I don't have access to do so myself.
--
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@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] MarcusSorealheis commented on a diff in pull request #1629: MINOR: Fix typos in `org.apache.solr.core` package
Posted by "MarcusSorealheis (via GitHub)" <gi...@apache.org>.
MarcusSorealheis commented on code in PR #1629:
URL: https://github.com/apache/solr/pull/1629#discussion_r1187033556
##########
solr/core/src/java/org/apache/solr/core/backup/repository/BackupRepositoryFactory.java:
##########
@@ -78,7 +78,7 @@ public BackupRepository newInstance(SolrResourceLoader loader, String name) {
BackupRepository result = loader.newInstance(repo.className, BackupRepository.class);
if ("trackingBackupRepository".equals(name)) {
// newInstance can be called by multiple threads, synchronization prevents simultaneous
- // multi-threaded 'adds' from corrupting the namedlist
+ // multithreaded 'adds' from corrupting the namedlist
Review Comment:
```suggestion
// multithreaded 'adds' from corrupting the NamedList
```
--
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@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] MarcusSorealheis commented on a diff in pull request #1629: MINOR: Fix typos in `org.apache.solr.core` package
Posted by "MarcusSorealheis (via GitHub)" <gi...@apache.org>.
MarcusSorealheis commented on code in PR #1629:
URL: https://github.com/apache/solr/pull/1629#discussion_r1187024838
##########
solr/core/src/java/org/apache/solr/core/backup/repository/BackupRepositoryFactory.java:
##########
@@ -78,7 +78,7 @@ public BackupRepository newInstance(SolrResourceLoader loader, String name) {
BackupRepository result = loader.newInstance(repo.className, BackupRepository.class);
if ("trackingBackupRepository".equals(name)) {
// newInstance can be called by multiple threads, synchronization prevents simultaneous
- // multi-threaded 'adds' from corrupting the namedlist
+ // multithreaded 'adds' from corrupting the namedlist
Review Comment:
echoing @janhoy, I appreciate the attention to detail.
While we are at it, do you think it would be too much to ask to change the mentions of `NamedList` in the comments to follow their used convention, `NamedList`? This change would be important for users searching the codebase here with case sensitivity enabled, which is quite common.
--
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@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] HoustonPutman commented on pull request #1629: MINOR: Fix typos in `org.apache.solr.core` package
Posted by "HoustonPutman (via GitHub)" <gi...@apache.org>.
HoustonPutman commented on PR #1629:
URL: https://github.com/apache/solr/pull/1629#issuecomment-1654248946
backported to 9.4
--
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@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] MarcusSorealheis commented on a diff in pull request #1629: MINOR: Fix typos in `org.apache.solr.core` package
Posted by "MarcusSorealheis (via GitHub)" <gi...@apache.org>.
MarcusSorealheis commented on code in PR #1629:
URL: https://github.com/apache/solr/pull/1629#discussion_r1187036771
##########
solr/core/src/java/org/apache/solr/core/SolrCore.java:
##########
@@ -403,12 +403,12 @@ public String getIndexDir() {
/**
* Returns the indexdir as given in index.properties. If index.properties exists in dataDir and
- * there is a property <i>index</i> available and it points to a valid directory in dataDir that
+ * there is a property <i>index</i> available, and it points to a valid directory in dataDir that
* is returned. Else dataDir/index is returned. Only called for creating new indexSearchers and
* indexwriters. Use the getIndexDir() method to know the active index directory
*
* @return the indexdir as given in index.properties
- * @throws SolrException if for any reason the a reasonable index directory cannot be determined.
+ * @throws SolrException if for any reason a reasonable index directory cannot be determined.
Review Comment:
Here is another typo I found just about the `SolrException` referenced in the line changed. Should be `were`.
https://github.com/apache/solr/blob/c68d519604bea474dd842da135e4e7c358284846/solr/core/src/java/org/apache/solr/core/SolrCore.java#L429
--
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@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] MarcusSorealheis commented on a diff in pull request #1629: MINOR: Fix typos in `org.apache.solr.core` package
Posted by "MarcusSorealheis (via GitHub)" <gi...@apache.org>.
MarcusSorealheis commented on code in PR #1629:
URL: https://github.com/apache/solr/pull/1629#discussion_r1187024838
##########
solr/core/src/java/org/apache/solr/core/backup/repository/BackupRepositoryFactory.java:
##########
@@ -78,7 +78,7 @@ public BackupRepository newInstance(SolrResourceLoader loader, String name) {
BackupRepository result = loader.newInstance(repo.className, BackupRepository.class);
if ("trackingBackupRepository".equals(name)) {
// newInstance can be called by multiple threads, synchronization prevents simultaneous
- // multi-threaded 'adds' from corrupting the namedlist
+ // multithreaded 'adds' from corrupting the namedlist
Review Comment:
echoing @janhoy, I appreciate the attention to detail.
While we are at it, do you think it would be too much to ask to change the mentions of `namedList` in the comments to follow their used convention, `namedList`? This change would be important for users searching the codebase here with case sensitivity enabled, which is quite common.
--
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@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] MarcusSorealheis commented on a diff in pull request #1629: MINOR: Fix typos in `org.apache.solr.core` package
Posted by "MarcusSorealheis (via GitHub)" <gi...@apache.org>.
MarcusSorealheis commented on code in PR #1629:
URL: https://github.com/apache/solr/pull/1629#discussion_r1187033425
##########
solr/core/src/java/org/apache/solr/core/backup/repository/BackupRepositoryFactory.java:
##########
@@ -78,7 +78,7 @@ public BackupRepository newInstance(SolrResourceLoader loader, String name) {
BackupRepository result = loader.newInstance(repo.className, BackupRepository.class);
if ("trackingBackupRepository".equals(name)) {
// newInstance can be called by multiple threads, synchronization prevents simultaneous
- // multi-threaded 'adds' from corrupting the namedlist
+ // multithreaded 'adds' from corrupting the namedlist
Review Comment:
lol - even I made a mistake in the correction. It's `NamedList`.
--
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@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] MarcusSorealheis commented on a diff in pull request #1629: MINOR: Fix typos in `org.apache.solr.core` package
Posted by "MarcusSorealheis (via GitHub)" <gi...@apache.org>.
MarcusSorealheis commented on code in PR #1629:
URL: https://github.com/apache/solr/pull/1629#discussion_r1187036771
##########
solr/core/src/java/org/apache/solr/core/SolrCore.java:
##########
@@ -403,12 +403,12 @@ public String getIndexDir() {
/**
* Returns the indexdir as given in index.properties. If index.properties exists in dataDir and
- * there is a property <i>index</i> available and it points to a valid directory in dataDir that
+ * there is a property <i>index</i> available, and it points to a valid directory in dataDir that
* is returned. Else dataDir/index is returned. Only called for creating new indexSearchers and
* indexwriters. Use the getIndexDir() method to know the active index directory
*
* @return the indexdir as given in index.properties
- * @throws SolrException if for any reason the a reasonable index directory cannot be determined.
+ * @throws SolrException if for any reason a reasonable index directory cannot be determined.
Review Comment:
Here is another typo I found just above the `SolrException` referenced in the line changed. Should be `were`.
https://github.com/apache/solr/blob/c68d519604bea474dd842da135e4e7c358284846/solr/core/src/java/org/apache/solr/core/SolrCore.java#L429
--
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@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org
[GitHub] [solr] MarcusSorealheis commented on pull request #1629: MINOR: Fix typos in `org.apache.solr.core` package
Posted by "MarcusSorealheis (via GitHub)" <gi...@apache.org>.
MarcusSorealheis commented on PR #1629:
URL: https://github.com/apache/solr/pull/1629#issuecomment-1538828016
@AndreyBozhko can you add an entry in `CHANGES.txt`
--
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@solr.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org