Spelling corrections by jsoref · Pull Request #1798 · apache/hugegraph

jsoref · 2022-03-28T02:33:07Z

This PR corrects misspellings identified by the check-spelling action.

The misspellings have been reported at jsoref@e94f980#commitcomment-69669718

The action reports that the changes in this PR would make it happy: jsoref@45806c1

Note: this PR does not include the action. If you're interested in running a spell check on every PR and push, that can be offered separately.

Signed-off-by: Josh Soref <[email protected]>

github-actions · 2022-03-28T02:33:57Z

CLA Assistant Lite bot Good! All Contributors have signed the CLA.

jsoref

Corrections mostly automatically suggested by Google Sheets.

All fault mine.

jsoref · 2022-03-28T02:33:23Z

CONTRIBUTING.md

 5. Sign the HugeGraph CLA: [https://cla-assistant.io/hugegraph/hugegraph](https://cla-assistant.io/hugegraph/hugegraph)

-Optional: You can use [Github desktop](https://desktop.github.com/) to greatly simplify the commit and update process.
+Optional: You can use [GitHub desktop](https://desktop.github.com/) to greatly simplify the commit and update process.


hugegraph-test/src/main/java/com/baidu/hugegraph/unit/core/RangeTest.java

hugegraph-test/src/main/java/com/baidu/hugegraph/api/BaseApiTest.java

jsoref · 2022-03-28T02:36:54Z

...ostgresql/src/main/java/com/baidu/hugegraph/backend/store/postgresql/PostgresqlSessions.java

                conn.createStatement().execute(sql);
            } catch (PSQLException e) {
-                // CockroackDB not support 'template' arg of CREATE DATABASE
+                // CockroachDB not support 'template' arg of CREATE DATABASE


jsoref · 2022-03-28T02:37:09Z

hugegraph-palo/src/main/java/com/baidu/hugegraph/backend/store/palo/PaloOptions.java

            new ConfigOption<>(
                    "palo.poll_interval",
-                    "The execution peroid of the background thread that " +
+                    "The execution period of the background thread that " +


User facing config

jsoref · 2022-03-28T02:38:43Z

hugegraph-example/src/main/java/com/baidu/hugegraph/example/Example2.java

        GraphTraversalSource g = graph.traversal();

-        GraphTraversal<Vertex, Vertex> vertexs = g.V();
+        GraphTraversal<Vertex, Vertex> vertices = g.V();


this is 200:1 vs vertexes

jsoref · 2022-03-28T02:39:16Z

hugegraph-dist/src/assembly/travis/mysql.cnf


 # Ensure operations involving astral characters fail loudly,
-# rather than mysql silently replacing each each byte of the
+# rather than mysql silently replacing each byte of the


This isn't strictly a spelling thing, but spell checkers have been complaining about doubled words for decades, so my tool now includes this as well...

nice catch for your spelling-check tool, we do need the rule

jsoref · 2022-03-28T02:39:44Z

hugegraph-core/src/main/java/com/baidu/hugegraph/type/Indexifiable.java

 import com.baidu.hugegraph.backend.id.Id;

-public interface Indexfiable {
+public interface Indexifiable {


@javeme maybe we should check the influence in other repository, however we need correct it before move to apache

and thanks @jsoref for reminding, is it also an automatic rule in your tool?

The tool recognized this as a non-word. The correction here was manual (Google Sheets guessed Index Fiable).

Picking correct words is generally left as the responsibility of a human, although for large lists, I'm able to leverage Google Sheets corrections for some portion of items.

I think "Indexable" is a more appropriate word here

Oh, I should note that the places where I comment about api breaks are purely manual, it's my way of saying "I'm a human, not a robot, I do understand that changes have consequences". They also aren't necessarily exhaustive (I tend to do this changes while exhausted...).

jsoref · 2022-03-28T02:45:27Z

hugegraph-core/src/main/java/com/baidu/hugegraph/config/CoreOptions.java

    public static final ConfigOption<Long> SNOWFLAKE_DATACENTER_ID =
            new ConfigOption<>(
-                    "snowflake.datecenter_id",
+                    "snowflake.datacenter_id",


Config break

yep, although this config influence little, we should update the doc later (mark)

jsoref · 2022-03-28T02:46:14Z

hugegraph-core/src/main/java/com/baidu/hugegraph/backend/store/BackendTable.java

+    /****************************** ShardSplitter ******************************/

-    public static abstract class ShardSpliter<Session extends BackendSession> {
+    public static abstract class ShardSplitter<Session extends BackendSession> {


imbajin · 2022-03-28T03:18:22Z

hugegraph-mysql/src/main/java/com/baidu/hugegraph/backend/store/mysql/MysqlSerializer.java

                                   TableBackendEntry.Row row) {
        String properties = row.column(HugeKeys.PROPERTIES);
-        // Query edge will wraped by a vertex, whose properties is empty
+        // Query edge will wrapped by a vertex, whose properties is empty


will wrapped --> wil be wrapped? (Can this be detected? lack be)

Kinda. It isn't a grammar checker, but if you know someone is going to make a certain kind of mistake and can describe it with a regular expression, then, yes.

This is the set of supplemental rules that were used for this PR:
https://github.com/jsoref/hugegraph/blob/spell-check/.github/actions/spelling/line_forbidden.patterns

Only the last one is actually fancy.

But, you could do something like:

# s.b. will _be_ ... \bwill [a-z]{3,}ed\b

Note that this heuristic would fail for will speed up (bumping to {4,} would cover that case).

I haven't thought through these edges before.

In theory, there may be grammar checkers available for GitHub, although, I can't point to any as GitHub Actions.

imbajin · 2022-03-28T06:05:00Z

recheck

javeme

Thank you very much for your contribution! Nice tool.

hugegraph-core/src/main/java/com/baidu/hugegraph/traversal/optimize/TraversalUtil.java

hugegraph-example/src/main/java/com/baidu/hugegraph/example/PerfExample1.java

javeme · 2022-03-28T06:03:14Z

hugegraph-test/src/main/java/com/baidu/hugegraph/api/BaseApiTest.java

        List<Map> vertices = readList(content, "vertices", Map.class);

-        Map<String, String> vertextName2Ids = new HashMap<>();
+        Map<String, String> vertexName2Ids = new HashMap<>();


s/vertext/vertex

javeme · 2022-03-28T06:07:18Z

hugegraph-test/src/main/java/com/baidu/hugegraph/unit/cassandra/CassandraTest.java


    @Test
-    public void testParseRepilcaWithSimpleStrategy() {
+    public void testParseReplicaWithSimpleStrategy() {


s/Repilc/Repilca

hugegraph-test/src/main/java/com/baidu/hugegraph/unit/core/RangeTest.java

javeme · 2022-03-28T06:16:34Z

hugegraph-core/src/main/java/com/baidu/hugegraph/type/Indexifiable.java

 import com.baidu.hugegraph.backend.id.Id;

-public interface Indexfiable {
+public interface Indexifiable {


I think "Indexable" is a more appropriate word here

hugegraph-core/src/main/java/com/baidu/hugegraph/schema/SchemaLabel.java

jsoref · 2022-03-28T11:31:37Z

APACHE_PROPOSAL.md

 #### Relationship with Titan/Janus Graph

-In the early stage of the project, we referred to the storage structure of Titan/Janus Graph, some folks thought that HugeGraph was forked from Titan/Janus. In fact, HugeGraph is not based on these projects. HugeGraph is developed completely from scratch and in the process it addressed many new challenges. Certainly, the project was inspired by Titan/Janus and we are really gratitious for such inspirations.
+In the early stage of the project, we referred to the storage structure of Titan/Janus Graph, some folks thought that HugeGraph was forked from Titan/Janus. In fact, HugeGraph is not based on these projects. HugeGraph is developed completely from scratch and in the process it addressed many new challenges. Certainly, the project was inspired by Titan/Janus and we are really gratuitous for such inspirations.


I should note that the downside of a spelling oriented automated fix is that one can get a correctly spelled word that one shouldn't use. This is an example.
https://github.com/hugegraph/hugegraph/pull/1797#discussion_r836326440

Signed-off-by: Josh Soref <[email protected]>

codecov · 2022-03-28T15:53:58Z

Codecov Report

Merging #1798 (922d3d3) into master (b591f7d) will increase coverage by 3.96%.
The diff coverage is 79.59%.

@@             Coverage Diff              @@
##             master    #1798      +/-   ##
============================================
+ Coverage     66.91%   70.87%   +3.96%     
  Complexity      978      978              
============================================
  Files           446      446              
  Lines         37781    37781              
  Branches       5380     5380              
============================================
+ Hits          25281    26778    +1497     
+ Misses         9776     8282    -1494     
+ Partials       2724     2721       -3

Impacted Files	Coverage Δ
...va/com/baidu/hugegraph/auth/HugeAuthenticator.java	`40.21% <0.00%> (ø)`
...ava/com/baidu/hugegraph/define/UpdateStrategy.java	`16.36% <ø> (ø)`
...n/java/com/baidu/hugegraph/version/ApiVersion.java	`75.00% <ø> (ø)`
...egraph/backend/store/cassandra/CassandraStore.java	`74.07% <ø> (ø)`
.../java/com/baidu/hugegraph/auth/ResourceObject.java	`96.55% <ø> (ø)`
...in/java/com/baidu/hugegraph/auth/SchemaDefine.java	`76.10% <ø> (ø)`
...gegraph/backend/serializer/BinaryBackendEntry.java	`79.54% <ø> (+5.68%)`	⬆️
...ugegraph/backend/serializer/TableBackendEntry.java	`88.88% <ø> (ø)`
...hugegraph/backend/serializer/TextBackendEntry.java	`83.33% <ø> (ø)`
...u/hugegraph/backend/serializer/TextSerializer.java	`86.24% <ø> (ø)`
... and 150 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b591f7d...922d3d3. Read the comment docs.

imbajin

Thanks for your contribution, u could submit another pr for github action u mentioned before ~

jsoref added 13 commits March 27, 2022 20:59

Mark StringEncodingTest.java as text

f16c8fa

Signed-off-by: Josh Soref <[email protected]>

spelling: backend

53d1fb9

Signed-off-by: Josh Soref <[email protected]>

spelling: bodies

cc74a5b

Signed-off-by: Josh Soref <[email protected]>

spelling: caching

2d1ba36

Signed-off-by: Josh Soref <[email protected]>

spelling: capacity

855fe72

Signed-off-by: Josh Soref <[email protected]>

spelling: clause

46d9d1f

Signed-off-by: Josh Soref <[email protected]>

spelling: cockroach

07dcbb1

Signed-off-by: Josh Soref <[email protected]>

spelling: committed

f79acf6

Signed-off-by: Josh Soref <[email protected]>

spelling: datacenter

d5b1682

Signed-off-by: Josh Soref <[email protected]>

spelling: decompress

324617e

Signed-off-by: Josh Soref <[email protected]>

spelling: destroy

efecaee

Signed-off-by: Josh Soref <[email protected]>

spelling: each

0ca5d70

Signed-off-by: Josh Soref <[email protected]>

spelling: github

ec1637e

Signed-off-by: Josh Soref <[email protected]>

jsoref commented Mar 28, 2022

View reviewed changes

jsoref mentioned this pull request Mar 28, 2022

Proposal tweaks #1797

Merged

imbajin reviewed Mar 28, 2022

View reviewed changes

javeme reviewed Mar 28, 2022

View reviewed changes

javeme changed the title ~~Spelling~~ Spelling corrections Mar 28, 2022

jsoref commented Mar 28, 2022

View reviewed changes

jsoref added 2 commits March 28, 2022 09:33

spelling: http

462e800

Signed-off-by: Josh Soref <[email protected]>

spelling: implementation

7d1bd9b

Signed-off-by: Josh Soref <[email protected]>

jsoref force-pushed the spelling branch from d486b8a to a92e420 Compare March 28, 2022 13:33

jsoref added 2 commits March 28, 2022 09:55

spelling: indexable

a3c0b80

Signed-off-by: Josh Soref <[email protected]>

spelling: mergeable

9aab4d1

Signed-off-by: Josh Soref <[email protected]>

jsoref force-pushed the spelling branch 3 times, most recently from 6a1755f to 09d3a9a Compare March 28, 2022 14:06

spelling: nameable

dd702b3

Signed-off-by: Josh Soref <[email protected]>

jsoref added 24 commits March 28, 2022 10:11

spelling: prefixes

fe3524a

Signed-off-by: Josh Soref <[email protected]>

spelling: projects

8ac2136

Signed-off-by: Josh Soref <[email protected]>

spelling: propertiable

e4fc294

Signed-off-by: Josh Soref <[email protected]>

spelling: properties

4ccfab3

Signed-off-by: Josh Soref <[email protected]>

spelling: property

2cde9f7

Signed-off-by: Josh Soref <[email protected]>

spelling: query

fdd0734

Signed-off-by: Josh Soref <[email protected]>

spelling: replica

43e1725

Signed-off-by: Josh Soref <[email protected]>

spelling: retrieve

70f81d5

Signed-off-by: Josh Soref <[email protected]>

spelling: running

319526d

Signed-off-by: Josh Soref <[email protected]>

spelling: scanning

94cf54e

Signed-off-by: Josh Soref <[email protected]>

spelling: separate

3d87c17

Signed-off-by: Josh Soref <[email protected]>

spelling: set

d7d2a6b

Signed-off-by: Josh Soref <[email protected]>

spelling: shouldn't

9ac2556

Signed-off-by: Josh Soref <[email protected]>

spelling: single

a832c3c

Signed-off-by: Josh Soref <[email protected]>

spelling: splitter

8858e35

Signed-off-by: Josh Soref <[email protected]>

spelling: timestamp

4e4357c

Signed-off-by: Josh Soref <[email protected]>

spelling: transfer

79f44fb

Signed-off-by: Josh Soref <[email protected]>

spelling: transferred

4d5635e

Signed-off-by: Josh Soref <[email protected]>

spelling: typeable

8f4bd86

Signed-off-by: Josh Soref <[email protected]>

spelling: vertex

2e8efe8

Signed-off-by: Josh Soref <[email protected]>

spelling: vertices

f6e267c

Signed-off-by: Josh Soref <[email protected]>

spelling: with

f09909c

Signed-off-by: Josh Soref <[email protected]>

spelling: wrapped

ce29cd5

Signed-off-by: Josh Soref <[email protected]>

spelling: write

922d3d3

Signed-off-by: Josh Soref <[email protected]>

jsoref force-pushed the spelling branch from 09d3a9a to 922d3d3 Compare March 28, 2022 14:13

javeme approved these changes Mar 28, 2022

View reviewed changes

imbajin approved these changes Mar 30, 2022

View reviewed changes

javeme merged commit 5368f32 into apache:master Mar 30, 2022

jsoref deleted the spelling branch March 30, 2022 09:26

Conversation

jsoref commented Mar 28, 2022

Uh oh!

github-actions bot commented Mar 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jsoref left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jsoref Mar 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

imbajin Mar 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jsoref Mar 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

imbajin commented Mar 28, 2022

Uh oh!

javeme left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Mar 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

imbajin left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

github-actions bot commented Mar 28, 2022 •

edited

Loading

jsoref Mar 28, 2022 •

edited

Loading

imbajin Mar 28, 2022 •

edited

Loading

jsoref Mar 28, 2022 •

edited

Loading

codecov bot commented Mar 28, 2022 •

edited

Loading