chore: fix typos #1439
chore: fix typos #1439
Conversation
Signed-off-by: snoppy <michaleli@foxmail.com>
WalkthroughThe changes made across various files are primarily focused on correcting typos in comments to improve clarity and accuracy. No functional code modifications were made, ensuring that the logic and behavior of the code remain unchanged. This update enhances the readability and professionalism of the codebase without altering its functionality. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![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
Outside diff range and nitpick comments (2)
src/fuzz/README.md (2)
Line range hint
136-136: Remove duplicated word for clarity.- To view the result run run `firefox ./merged-output/index.html`. + To view the result run `firefox ./merged-output/index.html`.
Line range hint
139-139: Use "an" instead of "a" before a vowel sound.- This will start a http server at http://0.0.0.0:8000/ + This will start an http server at http://0.0.0.0:8000/
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (6)
- src/crypto/MerkleTreeProof/argon2.h (1 hunks)
- src/ctpl.h (1 hunks)
- src/fixed.h (1 hunks)
- src/fuzz/FuzzedDataProvider.h (1 hunks)
- src/fuzz/README.md (2 hunks)
- src/hdmint/wallet.cpp (1 hunks)
Files skipped from review due to trivial changes (5)
- src/crypto/MerkleTreeProof/argon2.h
- src/ctpl.h
- src/fixed.h
- src/fuzz/FuzzedDataProvider.h
- src/hdmint/wallet.cpp
Additional Context Used
LanguageTool (10)
src/fuzz/README.md (10)
Near line 24: Possible missing comma found.
Context: ...uzz make sudo make install ``` For more information you can look at https://github.com/goog...
Near line 26: Consider a shorter alternative to avoid wordiness.
Context: ...he following boost and ssl dependencies in order to compile the fuzzing harness: ``` sudo ...
Near line 39: Consider a shorter alternative to avoid wordiness.
Context: ...-dev ``` ### Fuzzing using honggfuzz * In order to fuzzfiro/src/libparkusing Honggfuzz...
Near line 78: The plural noun “corpora” cannot be used with the article “an”. Did you mean “an empty corpus” or “empty corpora”?
Context: ...p pressctrl+cHere we are providing an empty corpora. In case of an already available corpor...
Near line 132: Possible missing comma found.
Context: ... input_folder as the input corpora from fuzzing or one can also create it by running: `...
Near line 132: ‘preferred to have’ might be wordy. Consider a shorter alternative.
Context: ...ach input inside the input_folder, it's preferred to have only a few inputs, otherwise it will ta...
Near line 132: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...lder, it's preferred to have only a few inputs, otherwise it will take a long time to generate th...
Near line 135: The modal verb ‘will’ requires the verb’s base form.
Context: ...run./generate_coverage.sh. This will generated a merged output for all the inputs pres...
Near line 136: Possible typo: you repeated a word
Context: ...the input_folder. 5. To view the result run runfirefox ./merged-output/index.html. ...
Near line 139: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ython3 -m http.server`. This will start a http server at http://0.0.0.0:8000/ 8. ...
Markdownlint (68)
src/fuzz/README.md (68)
39: Expected: dash; Actual: asterisk
Unordered list style
61: Expected: dash; Actual: asterisk
Unordered list style
118: Expected: dash; Actual: asterisk
Unordered list style
72: Expected: 0 or 2; Actual: 1
Trailing spaces
83: Expected: 0 or 2; Actual: 1
Trailing spaces
99: Expected: 0 or 2; Actual: 1
Trailing spaces
116: Expected: 1; Actual: 2
Multiple consecutive blank lines
3: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
6: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
15: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
38: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
117: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines
8: null
Fenced code blocks should be surrounded by blank lines
10: null
Fenced code blocks should be surrounded by blank lines
17: null
Fenced code blocks should be surrounded by blank lines
23: null
Fenced code blocks should be surrounded by blank lines
54: null
Fenced code blocks should be surrounded by blank lines
56: null
Fenced code blocks should be surrounded by blank lines
64: null
Fenced code blocks should be surrounded by blank lines
66: null
Fenced code blocks should be surrounded by blank lines
68: null
Fenced code blocks should be surrounded by blank lines
84: null
Fenced code blocks should be surrounded by blank lines
89: null
Fenced code blocks should be surrounded by blank lines
96: null
Fenced code blocks should be surrounded by blank lines
98: null
Fenced code blocks should be surrounded by blank lines
100: null
Fenced code blocks should be surrounded by blank lines
105: null
Fenced code blocks should be surrounded by blank lines
107: null
Fenced code blocks should be surrounded by blank lines
109: null
Fenced code blocks should be surrounded by blank lines
111: null
Fenced code blocks should be surrounded by blank lines
119: null
Fenced code blocks should be surrounded by blank lines
128: null
Fenced code blocks should be surrounded by blank lines
7: null
Lists should be surrounded by blank lines
7: null
Lists should be surrounded by blank lines
11: null
Lists should be surrounded by blank lines
16: null
Lists should be surrounded by blank lines
16: null
Lists should be surrounded by blank lines
39: null
Lists should be surrounded by blank lines
63: null
Lists should be surrounded by blank lines
67: null
Lists should be surrounded by blank lines
67: null
Lists should be surrounded by blank lines
73: null
Lists should be surrounded by blank lines
95: null
Lists should be surrounded by blank lines
104: null
Lists should be surrounded by blank lines
118: null
Lists should be surrounded by blank lines
118: null
Lists should be surrounded by blank lines
11: null
Bare URL used
16: null
Bare URL used
24: null
Bare URL used
118: null
Bare URL used
139: null
Bare URL used
140: null
Bare URL used
8: null
Fenced code blocks should have a language specified
17: null
Fenced code blocks should have a language specified
28: null
Fenced code blocks should have a language specified
41: null
Fenced code blocks should have a language specified
49: null
Fenced code blocks should have a language specified
54: null
Fenced code blocks should have a language specified
64: null
Fenced code blocks should have a language specified
68: null
Fenced code blocks should have a language specified
84: null
Fenced code blocks should have a language specified
89: null
Fenced code blocks should have a language specified
96: null
Fenced code blocks should have a language specified
100: null
Fenced code blocks should have a language specified
105: null
Fenced code blocks should have a language specified
109: null
Fenced code blocks should have a language specified
119: null
Fenced code blocks should have a language specified
142: null
Files should end with a single newline character
| @@ -129,7 +129,7 @@ sudo make install | |||
| Once successfully installed, follow the below instructions to generate the code-coverage | |||
|
|
|||
| 1. First compile the harness with gdb flag. run `make <filename>_debug` inside src/fuzz to compile using gdb debugger. | |||
| 2. take the input_folder as the input corpora from fuzzing or one can also create it by running: `honggfuzz -i <input_folder> -– ./<filename>_hfuzz ___FILE___ @@`. This will start the fuzzer. Kill it by `ctrl+C`. The fuzzer will generate some random inputs inside the input_folder. Since kcov will generate coverage for each input inside the input_folder, it's preffered to have only a few inputs, otherwise it will take a long time to generate the entire coverage. | |||
| 2. take the input_folder as the input corpora from fuzzing or one can also create it by running: `honggfuzz -i <input_folder> -– ./<filename>_hfuzz ___FILE___ @@`. This will start the fuzzer. Kill it by `ctrl+C`. The fuzzer will generate some random inputs inside the input_folder. Since kcov will generate coverage for each input inside the input_folder, it's preferred to have only a few inputs, otherwise it will take a long time to generate the entire coverage. | |||
There was a problem hiding this comment.
Correct verb form for consistency and grammatical accuracy.
- This will generated a merged output for all the inputs present in the input_folder.
+ This will generate a merged output for all the inputs present in the input_folder.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.
| 2. take the input_folder as the input corpora from fuzzing or one can also create it by running: `honggfuzz -i <input_folder> -– ./<filename>_hfuzz ___FILE___ @@`. This will start the fuzzer. Kill it by `ctrl+C`. The fuzzer will generate some random inputs inside the input_folder. Since kcov will generate coverage for each input inside the input_folder, it's preferred to have only a few inputs, otherwise it will take a long time to generate the entire coverage. | |
| 2. take the input_folder as the input corpora from fuzzing or one can also create it by running: `honggfuzz -i <input_folder> -– ./<filename>_hfuzz ___FILE___ @@`. This will start the fuzzer. Kill it by `ctrl+C`. The fuzzer will generate some random inputs inside the input_folder. Since kcov will generate coverage for each input inside the input_folder, it's preferred to have only a few inputs, otherwise it will take a long time to generate the entire coverage. This will generate a merged output for all the inputs present in the input_folder. |
| @@ -75,7 +75,7 @@ example: | |||
| 2. `honggfuzz -i ../input -- ./../libspark/bpplus_hfuzz ___FILE___` | |||
| 3. To stop press `ctrl+c` | |||
|
|
|||
| Here we are providing an empty corpora. In case of an already available corpora, we can provide the availabe corpora. | |||
| Here we are providing an empty corpora. In case of an already available corpora, we can provide the available corpora. | |||
There was a problem hiding this comment.
Correct grammatical error in the use of "corpora".
- Here we are providing an empty corpora.
+ Here we are providing empty corpora.Committable suggestion was skipped due low confidence.
fix some typos