Correct spelling and terminology across JSON documentation and tests by jsoref · Pull Request #65 · valkey-io/valkey-json

jsoref · 2025-06-04T03:13:05Z

No description provided.

jsoref · 2025-06-04T03:13:36Z

    MODULE LOAD /path/to/libjson.so
 ```
-## Supported  Module Commands
+## Supported Module Commands


I don't usually make commits to drop spaces... this one seems like a pretty good candidate for dropping...

jsoref · 2025-06-04T03:14:56Z

    \brief Macro to indicate a parse error.
    \param parseErrorCode \ref rapidjson::ParseErrorCode of the error
-    \param offset  position of the error in JSON input (\c size_t)
+    \param offset position of the error in JSON input (\c size_t)


there were a couple of places where things appeared to be intentionally indented. This doesn't appear to be one of those cases...

jsoref · 2025-06-04T03:15:35Z

    }

-    // When read/write pointers are the same for insitu stream, just skip unescaped characters
+    // When read/write pointers are the same for in situ stream, just skip unescaped characters


Thi is the proper spelling for the phrase.

https://en.wikipedia.org/wiki/In_situ

Note that I'm not changingt the class as that seemed a bit too invasive...

jsoref · 2025-06-04T03:17:25Z

            assert exp.encode() == client.execute_command('JSON.GET', k2, path)

-        # we do not support mixing of  unions and slices, nor do we support extraneous commas
+        # we do not support mixing of unions and slices, nor do we support extraneous commas


this is why I included the commit to fix the doubled whitespace.

actually, this line helped me realize that one of my own rules was broken -- one of the benefits I get from running my rules against other projects is identifying bugs in them and fixing them...

jsoref · 2025-06-04T03:18:00Z

                'JSON.GET', key, path).decode()

-    def test_json_objectlen_command(self):
+    def test_json_object_len_command(self):


the actual things are objlen or objkeys, so I don't see any particular reason to invent additional new words just for these tests...

jsoref · 2025-06-04T03:18:40Z

 }

-TEST_F(DomTest, testNumMutiBy_int64) {
+TEST_F(DomTest, testNumMultiBy_int64) {


I'd personally favor Multiply, but this was the simplest fix

jsoref · 2025-06-04T03:19:07Z

                        "    \"my key\"   : \"key inside here\""
                        "  },"
-                        "  \"anonther object\" : {"
+                        "  \"another object\" : {"


GitHub CI passes...

roshkhatri

Over all looks good, just need change a few things. I would also like to see why the tests run. I am curious they didnt run on this

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

Co-authored-by: Roshan Khatri <117414976+roshkhatri@users.noreply.github.com> Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

coderabbitai · 2026-08-03T00:37:03Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 4f52f464-82c5-42e7-97ba-665b53cffdbc

📥 Commits

Reviewing files that changed from the base of the PR and between d6838b2 and 424d8ab.

📒 Files selected for processing (1)

src/json/json.cc

🚧 Files skipped from review as they are similar to previous changes (1)

src/json/json.cc

📝 Walkthrough

Walkthrough

The pull request corrects spelling, terminology, spacing, comments, documentation, test names, fixture text, and one local variable name. It does not change runtime behavior, public interfaces, build behavior, or test logic.

Changes

Documentation and naming cleanup

Layer / File(s)	Summary
Project and module text corrections `README.md`, `src/commands/json.mget.json`, `src/json/...`	Corrects project headings, command descriptions, module comments, error text spelling, and validation comment wording.
RapidJSON comment corrections `src/rapidjson/...`	Corrects documentation spacing, spelling, capitalization, and wording in RapidJSON headers.
Test comments and identifier corrections `tst/integration/...`, `tst/unit/...`	Corrects test comments, test method names, fixture text, test names, and the `metadata_val` local variable name.

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 27.27% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.
Description check	❓ Inconclusive	No pull request description was provided, so its relevance to the changeset cannot be assessed.	Add a concise description that summarizes the spelling, terminology, and comment corrections.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the spelling and terminology corrections made across JSON documentation and tests.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/json/json.cc`:
- Line 2612: Update the comment sentence near the background-operation check to
insert a comma after “progress,” so it reads grammatically as “As long as there
are no background operations in progress, we're good.”

In `@src/json/keytable.h`:
- Line 310: Rewrite the return-value comment near the affected function as a
complete sentence, correcting the capitalization and clearly stating that valid
factors return NULL while invalid factors return an error string.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: c2efa678-00a8-40f3-b41c-f78b5b85f39f

📥 Commits

Reviewing files that changed from the base of the PR and between 7d0acb4 and d6838b2.

📒 Files selected for processing (14)

README.md
src/commands/json.mget.json
src/json/json.cc
src/json/keytable.cc
src/json/keytable.h
src/rapidjson/document.h
src/rapidjson/reader.h
src/rapidjson/writer.h
tst/integration/test_json_basic.py
tst/integration/test_rdb.py
tst/unit/CMakeLists.txt
tst/unit/dom_test.cc
tst/unit/selector_test.cc
tst/unit/traps_test.cc

Signed-off-by: Roshan Khatri <117414976+roshkhatri@users.noreply.github.com>

roshkhatri · 2026-08-07T17:25:06Z

Sorry, one last thing, now that we are doing this can you also add a workflow for spellchek as well?
like this? and add the whitelisting spellings at this stage of the PR, no more changes
https://github.com/valkey-io/valkey/blob/unstable/.github/workflows/spell-check.yml

jsoref commented Jun 4, 2025

View reviewed changes

jsoref mentioned this pull request Jun 6, 2025

Spelling valkey-io/valkey-rfc#23

Open

Nikhil-Manglore approved these changes Jun 25, 2025

View reviewed changes

roshkhatri reviewed Aug 6, 2025

View reviewed changes

Comment thread src/json/json.cc Outdated

Comment thread src/json/json.cc

jsoref and others added 25 commits August 2, 2026 20:31

spelling:

5e7c187

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: ; otherwise,

35298d8

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: a

5161545

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: another

753c3a6

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: conversion

5ff6923

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: dance

2531042

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: empty

e3db6eb

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: filter

6c3de96

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: in situ

881f478

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: macos

06bc512

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: main thread

0805a9f

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: metadata

f0df0c2

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: multi

599e706

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: nonexistent

51f2115

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: object_keys

1f051c7

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: object_len

ede3c68

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: otherwise,

7bb962f

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: outstanding

20a7eb8

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: path

3d347f2

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: precision

7d59bfd

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: remove-member

aace870

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: set up

f3bdb44

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: store

6099834

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

spelling: threadsafe

61d5229

Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

Remove obsolete parenthetical

d6838b2

Co-authored-by: Roshan Khatri <117414976+roshkhatri@users.noreply.github.com> Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>

jsoref force-pushed the spelling branch from 7899343 to d6838b2 Compare August 3, 2026 00:34

coderabbitai Bot reviewed Aug 3, 2026

View reviewed changes

Comment thread src/json/json.cc Outdated

Comment thread src/json/keytable.h

roshkhatri changed the title ~~Spelling~~ Correct spelling and terminology across JSON documentation and tests Aug 3, 2026

roshkhatri reviewed Aug 4, 2026

View reviewed changes

Comment thread src/json/json.cc

roshkhatri reviewed Aug 5, 2026

View reviewed changes

Comment thread src/json/json.cc Outdated

Update src/json/json.cc

424d8ab

Signed-off-by: Roshan Khatri <117414976+roshkhatri@users.noreply.github.com>

Uh oh!

Conversation

jsoref commented Jun 4, 2025

Uh oh!

jsoref Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jsoref Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

jsoref Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jsoref Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

jsoref Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

jsoref Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

jsoref Jun 4, 2025

Choose a reason for hiding this comment

Uh oh!

roshkhatri left a comment • 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!

Uh oh!

Uh oh!

coderabbitai Bot commented Aug 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

❌ Failed checks (1 warning, 1 inconclusive)

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

roshkhatri commented Aug 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

roshkhatri left a comment •

edited

Loading

coderabbitai Bot commented Aug 3, 2026 •

edited

Loading