Spelling - #65
Conversation
| MODULE LOAD /path/to/libjson.so | ||
| ``` | ||
| ## Supported Module Commands | ||
| ## Supported Module Commands |
There was a problem hiding this comment.
I don't usually make commits to drop spaces... this one seems like a pretty good candidate for dropping...
| \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 was a problem hiding this comment.
there were a couple of places where things appeared to be intentionally indented. This doesn't appear to be one of those cases...
| } | ||
|
|
||
| // 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 |
There was a problem hiding this comment.
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...
| 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 |
There was a problem hiding this comment.
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...
| 'JSON.GET', key, path).decode() | ||
|
|
||
| def test_json_objectlen_command(self): | ||
| def test_json_object_len_command(self): |
There was a problem hiding this comment.
the actual things are objlen or objkeys, so I don't see any particular reason to invent additional new words just for these tests...
| } | ||
|
|
||
| TEST_F(DomTest, testNumMutiBy_int64) { | ||
| TEST_F(DomTest, testNumMultiBy_int64) { |
There was a problem hiding this comment.
I'd personally favor Multiply, but this was the simplest fix
| " \"my key\" : \"key inside here\"" | ||
| " }," | ||
| " \"anonther object\" : {" | ||
| " \"another object\" : {" |
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
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>
📝 WalkthroughWalkthroughThe 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. ChangesDocumentation and naming cleanup
Suggested reviewers: 🚥 Pre-merge checks | ✅ 2 | ❌ 3❌ Failed checks (1 warning, 2 inconclusive)
✅ Passed checks (2 passed)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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
📒 Files selected for processing (14)
README.mdsrc/commands/json.mget.jsonsrc/json/json.ccsrc/json/keytable.ccsrc/json/keytable.hsrc/rapidjson/document.hsrc/rapidjson/reader.hsrc/rapidjson/writer.htst/integration/test_json_basic.pytst/integration/test_rdb.pytst/unit/CMakeLists.txttst/unit/dom_test.cctst/unit/selector_test.cctst/unit/traps_test.cc
| // Resize the number of shards in the keyTable. this isn't multi-thread safe. But the current AppConfig architecture | ||
| // doesn't provide a good way to solve this problem. Also, we only do it when the table is empty. As long as there | ||
| // are no background operations in progress (slot migration, threadsave) we're good. Sadly there's no easy way for | ||
| // are no background operations in progress we're good. Sadly there's no easy way for |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add the missing comma.
The sentence should read “As long as there are no background operations in progress, we're good.”
Proposed fix
-// are no background operations in progress we're good. Sadly there's no easy way for
+// are no background operations in progress, we're good. Sadly there's no easy way for📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| // are no background operations in progress we're good. Sadly there's no easy way for | |
| // are no background operations in progress, we're good. Sadly there's no easy way for |
🤖 Prompt for 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.
In `@src/json/json.cc` at 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.”
| // | ||
| // Query if this set of factors is valid. | ||
| // returns: NULL, If the factors are valid. Otherwise an error string | ||
| // returns: NULL, If the factors are valid. Otherwise, an error string |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Rewrite the return-value comment as a complete sentence.
The current text still contains a capitalization error after the comma. It also does not clearly state that the function returns an error string.
Proposed fix
-// returns: NULL, If the factors are valid. Otherwise, an error string
+// Returns NULL if the factors are valid. Otherwise, it returns an error string.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| // returns: NULL, If the factors are valid. Otherwise, an error string | |
| // Returns NULL if the factors are valid. Otherwise, it returns an error string. |
🤖 Prompt for 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.
In `@src/json/keytable.h` at 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.
3 participants
No description provided.