Fix misspelled words in comments, error messages, and test code #32792

seratch · 2018-08-10T18:03:45Z

Fixing typos is sometimes very hard. It's not so easy to visually review them. Recently, I discovered a very useful tool for it, misspell.

This pull request fixes minor typos detected by misspell except for the false positives. If you would like me to work on other files as well, let me know.

Have you signed the contributor license agreement?
Have you followed the contributor guidelines?
If submitting code, have you built your formula locally prior to submission with gradle check?
If submitting code, is your pull request against master? Unless there is a good reason otherwise, we prefer pull requests against master and will backport as needed.
If submitting code, have you checked that your submission is for an OS that we support?
If you are submitting this code for a class then read our policy for that.

elasticmachine · 2018-08-13T10:56:39Z

Pinging @elastic/es-docs

seratch · 2018-08-14T05:53:04Z

After a few days, this pull request has become having a conflict with other merged changes. Thus, I've rebased on the master branch again and pushed it forcibly.

DaveCTurner

In general this looks good. I spotted a handful of changes that are still needed. I'm also not sure whether we should split this up into smaller sets of changes as I worry about merge conflicts and ease of backporting.

DaveCTurner · 2018-08-14T06:24:20Z

server/src/main/java/org/elasticsearch/index/store/Store.java

@@ -1063,7 +1063,7 @@ public int size() {
        }

        /**
-         * returns the history uuid the store points at, or null if not existant.
+         * returns the history uuid the store points at, or null if not existent.


I think not existent should be nonexistent.

Thanks. I've fixed it.

DaveCTurner · 2018-08-14T06:24:30Z

server/src/main/java/org/elasticsearch/index/translog/TranslogStats.java

@@ -85,12 +85,12 @@ public int estimatedNumberOfOperations() {
        return numberOfOperations;
    }

-    /** the size of the generations in the translog that weren't yet to comitted to lucene */
+    /** the size of the generations in the translog that weren't yet to committe to lucene */


committed

Thanks. I've fixed this and the same one in the same file as well.

DaveCTurner · 2018-08-14T06:24:35Z

server/src/main/java/org/elasticsearch/index/translog/TranslogStats.java

    public long getUncommittedSizeInBytes() {
        return uncommittedSizeInBytes;
    }

-    /** the number of operations in generations of the translog that weren't yet to comitted to lucene */
+    /** the number of operations in generations of the translog that weren't yet to committe to lucene */


committed

DaveCTurner · 2018-08-14T06:26:28Z

server/src/main/java/org/elasticsearch/rest/action/admin/cluster/RestGetRepositoriesAction.java

@@ -51,7 +51,7 @@ public RestGetRepositoriesAction(Settings settings, RestController controller, S

    @Override
    public String getName() {
-        return "get_respositories_action";
+        return "get_repositories_action";


Although this is a valid correction, this is also a breaking change. I think it only affects the REST Usage API, but I think this should be reverted and fixed separately.

Reverted and added a FIXME comment there. If the comment is unnecessary, I will remove it.

DaveCTurner · 2018-08-14T06:28:42Z

server/src/test/java/org/elasticsearch/rest/BaseRestHandlerTests.java

@@ -132,7 +132,7 @@ public String getName() {
            hasToString(containsString(
                "request [/] contains unrecognized parameters: " +
                    "[flied] -> did you mean [field]?, " +
-                    "[respones_param] -> did you mean [response_param]?, " +
+                    "[response_param] -> did you mean [response_param]?, " +


Lol. This mis-spelling is intentional.

Oops, I reverted it.

DaveCTurner · 2018-08-14T06:36:28Z

Please don't rebase this again, because rebasing loses inline comments from reviews. The preferred way to keep this in line with master is to merge master into the PR branch.

seratch · 2018-08-14T06:38:20Z

@DaveCTurner Thank you for your review. Since I have time to work on this now, I will fix the parts you pointed out very soon. Also, I don't rebase this branch anymore.

…the review

seratch · 2018-08-14T06:47:51Z

@DaveCTurner I've pushed a commit which reflects the updates. Could you review them again when you have time? 🙇

DaveCTurner · 2018-08-14T06:54:26Z

server/src/main/java/org/elasticsearch/rest/action/admin/cluster/RestGetRepositoriesAction.java

@@ -51,7 +51,8 @@ public RestGetRepositoriesAction(Settings settings, RestController controller, S

    @Override
    public String getName() {
-        return "get_repositories_action";
+        // FIXIME: the typo, just modifying the response will bring a breaking change to the REST Usage API, see also PR #32792


Better not to add this. Also FIXME contains a typo ;)

Oh... >typo

Thanks, I will remove the line.

DaveCTurner · 2018-08-14T06:55:19Z

@elasticmachine test this please

DaveCTurner · 2018-08-14T08:41:08Z

@elasticmachine test this please

DaveCTurner

I did another pass and found a few more things to fix. Additionally I pinged others for second opinions about three changes.

DaveCTurner · 2018-08-14T08:47:06Z

docs/plugins/repository-hdfs.asciidoc

@@ -32,7 +32,7 @@ PUT _snapshot/my_hdfs_repository
  "type": "hdfs",
  "settings": {
    "uri": "hdfs://namenode:8020/",
-    "path": "elasticsearch/respositories/my_hdfs_repository",
+    "path": "elasticsearch/repositories/my_hdfs_repository",


@jbaiera I can't judge the impact of this change. Ok with you?

DaveCTurner · 2018-08-14T08:50:32Z

docs/reference/mapping/types/percolator.asciidoc

@@ -372,7 +372,7 @@ GET /test_index/_search
    "percolate" : {
      "field" : "query",
      "document" : {
-        "body" : "Bycicles are missing"
+        "body" : "Bicycles are missing"


@martijnvg I think this change is ok but just checking with you that it wasn't deliberately misspelled for the example.

DaveCTurner · 2018-08-14T08:51:01Z

modules/reindex/src/test/java/org/elasticsearch/index/reindex/CancelTests.java

@@ -122,7 +122,7 @@ private void testCancel(String action, AbstractBulkByScrollRequestBuilder<?, ?>
        logger.debug("waiting for updates to be blocked");
        boolean blocked = awaitBusy(
            () -> ALLOWED_OPERATIONS.hasQueuedThreads() && ALLOWED_OPERATIONS.availablePermits() == 0,
-            1, TimeUnit.MINUTES); // 10 seconds is usually fine but on heavilly loaded machines this can wake a while


s/wake/take/

Also fixed.

DaveCTurner · 2018-08-14T08:54:25Z

...plugin/ml/src/main/java/org/elasticsearch/xpack/ml/rest/results/RestGetCategoriesAction.java

@@ -39,7 +39,7 @@ public RestGetCategoriesAction(Settings settings, RestController controller) {

    @Override
    public String getName() {
-        return "xpack_ml_get_catagories_action";
+        return "xpack_ml_get_categories_action";


This is also a breaking change, so needs to be done separately.

DaveCTurner · 2018-08-14T08:56:01Z

...test/java/org/elasticsearch/xpack/security/authc/ldap/support/LdapMetaDataResolverTests.java

@@ -40,7 +40,7 @@ public void testResolveSingleValuedAttributeFromCachedAttributes() throws Except
                new Attribute("cn", "Clint Barton"),
                new Attribute("uid", "hawkeye"),
                new Attribute("email", "clint.barton@shield.gov"),
-                new Attribute("memberOf", "cn=staff,ou=groups,dc=exmaple,dc=com", "cn=admin,ou=groups,dc=exmaple,dc=com")
+                new Attribute("memberOf", "cn=staff,ou=groups,dc=example,dc=com", "cn=admin,ou=groups,dc=example,dc=com")


@tvernum this fix looks ok to me, but just checking with you that it wasn't a deliberate typo?

No, this wasn't deliberate.

DaveCTurner · 2018-08-14T08:57:00Z

x-pack/plugin/src/test/resources/rest-api-spec/test/rollup/start_job.yml

@@ -37,7 +37,7 @@ setup:
          }

 ---
-"Test start non-existant job":
+"Test start non-existent job":


nonexistent needs no hyphen

DaveCTurner · 2018-08-14T08:57:06Z

x-pack/plugin/src/test/resources/rest-api-spec/test/rollup/stop_job.yml

@@ -37,7 +37,7 @@ setup:
          }

 ---
-"Test stop non-existant job":
+"Test stop non-existent job":


nonexistent needs no hyphen

DaveCTurner · 2018-08-14T08:59:03Z

server/src/test/java/org/elasticsearch/rest/BaseRestHandlerTests.java

@@ -119,7 +119,7 @@ public String getName() {
        final HashMap<String, String> params = new HashMap<>();
        params.put("consumed", randomAlphaOfLength(8));
        params.put("flied", randomAlphaOfLength(8));
-        params.put("respones_param", randomAlphaOfLength(8));
+        params.put("response_param", randomAlphaOfLength(8));


This misspelling was deliberate - it's testing the "did you mean" functionality.

…the review

DaveCTurner · 2018-08-14T15:00:56Z

@elasticmachine test this please

seratch · 2018-08-20T09:44:04Z

@DaveCTurner I just resolved the conflict with the latest revision. If there is something I can do for this pull request, please let me know at any time.

DaveCTurner

This LGTM, thanks so much for your efforts. I will start a full CI run now.

DaveCTurner · 2018-08-20T15:17:30Z

@elasticmachine test this please

DaveCTurner · 2018-08-20T16:55:44Z

@elasticmachine test this please

DaveCTurner · 2018-08-21T08:00:32Z

HighlighterSearchIT fails because it cares too deeply about the lengths of words, and fixing the spelling of highlighed to highlighted changes this. I reverted this change.

@elasticmachine test this please.

javanna · 2018-10-03T08:35:34Z

it seems like this got outdated and there are some merge conflicts. What do you suggest to do @DaveCTurner ? Do you plan on getting back to it?

seratch · 2018-10-03T09:12:11Z

Thank you for your response. I am fine even if you close this PR without merging due to lack of time for it. I understand most of the changes included in this PR are not crucial for the project.

DaveCTurner · 2018-10-03T10:43:56Z

Apologies, I forgot to assign this to myself before going on holiday so it dropped off my list. I will try and bring it in line with master again.

DaveCTurner · 2018-10-03T11:17:00Z

@elasticmachine test this please

DaveCTurner · 2018-10-03T11:33:31Z

@elasticmachine test this please

javanna · 2018-10-03T19:29:52Z

thanks so much @DaveCTurner !!!

seratch · 2018-10-03T22:32:23Z

@DaveCTurner Thank you for merging this 👍

DaveCTurner · 2018-10-04T09:23:33Z

You're welcome @javanna, and @seratch, thank you in turn for your efforts here.

seratch force-pushed the fix-typo branch from 72ce00e to 64a5e60 Compare August 10, 2018 18:05

colings86 added >docs General docs changes :Docs labels Aug 13, 2018

Fix misspelled words in comments, error messages, and test code

bee39a3

seratch force-pushed the fix-typo branch from 64a5e60 to bee39a3 Compare August 14, 2018 05:51

DaveCTurner requested changes Aug 14, 2018

View reviewed changes

Re-fix / revert a portion of the PR elastic#32792 changes, following …

51822cd

…the review

DaveCTurner reviewed Aug 14, 2018

View reviewed changes

Remove an unnecessary comment

ce6fc35

DaveCTurner requested changes Aug 14, 2018

View reviewed changes

Re-fix / revert a portion of the PR elastic#32792 changes, following …

14b66de

…the review

Merge branch 'master' into fix-typo

b79b624

DaveCTurner added v7.0.0 v6.5.0 labels Aug 20, 2018

DaveCTurner approved these changes Aug 20, 2018

View reviewed changes

Merge branch 'master' into fix-typo

420e3b0

DaveCTurner added 2 commits August 21, 2018 08:55

Merge branch 'master' into fix-typo

76d5d8c

Back out changes to HighlighterSearchIT

916fa9a

DaveCTurner self-assigned this Oct 3, 2018

Merge branch 'master' into fix-typo

3d13bc8

Revert change to percolator.asciidoc due to failing test

c67057f

DaveCTurner merged commit d45fe43 into elastic:master Oct 3, 2018

DaveCTurner pushed a commit that referenced this pull request Oct 3, 2018

Fix a variety of typos and misspelled words (#32792)

b56d0a2

seratch deleted the fix-typo branch October 3, 2018 22:32

kcm pushed a commit that referenced this pull request Oct 30, 2018

Fix a variety of typos and misspelled words (#32792)

e5eed99

jimczi added v7.0.0-beta1 and removed v7.0.0 labels Feb 7, 2019

Fix misspelled words in comments, error messages, and test code #32792

Fix misspelled words in comments, error messages, and test code #32792

Conversation

seratch commented Aug 10, 2018

elasticmachine commented Aug 13, 2018

seratch commented Aug 14, 2018

DaveCTurner left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DaveCTurner commented Aug 14, 2018

seratch commented Aug 14, 2018

seratch commented Aug 14, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DaveCTurner commented Aug 14, 2018

DaveCTurner commented Aug 14, 2018

DaveCTurner left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DaveCTurner commented Aug 14, 2018

seratch commented Aug 20, 2018

DaveCTurner left a comment

Choose a reason for hiding this comment

DaveCTurner commented Aug 20, 2018

DaveCTurner commented Aug 20, 2018

DaveCTurner commented Aug 21, 2018

javanna commented Oct 3, 2018

seratch commented Oct 3, 2018

DaveCTurner commented Oct 3, 2018

DaveCTurner commented Oct 3, 2018

DaveCTurner commented Oct 3, 2018

javanna commented Oct 3, 2018

seratch commented Oct 3, 2018

DaveCTurner commented Oct 4, 2018