docs: make minor edits to the Arguments section of the documentation
#568
Conversation
- give all arguments the same format - correct spelling for `separately` and `yourself` - remove extra whitespace in sentence
WalkthroughThe pull request involves minor formatting updates to the Changes
Poem
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration 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: 0
🧹 Nitpick comments (2)
README.md (2)
67-67: Fix grammar in the timeout description.The sentence has a grammatical error in the phrase "same timeout on two phase".
Apply this diff to fix the grammar:
- - ***timeout*** Number | Array - Request timeout in milliseconds for connecting phase and response receiving phase. Default is `5000`. You can use `timeout: 5000` to tell urllib use same timeout on two phase or set them separately such as `timeout: [3000, 5000]`, which will set connecting timeout to 3s and response 5s. + - ***timeout*** Number | Array - Request timeout in milliseconds for connecting phase and response receiving phase. Default is `5000`. You can use `timeout: 5000` to tell urllib to use the same timeout on both phases or set them separately such as `timeout: [3000, 5000]`, which will set connecting timeout to 3s and response 5s.🧰 Tools
🪛 LanguageTool
[grammar] ~67-~67: Possible agreement error. The noun ‘phase’ seems to be countable.
Context: ... to tell urllib use same timeout on two phase or set them separately such as `timeout...(CD_NN)
74-74: Fix spelling in the beforeRequest description.The phrase "every thing" should be "everything" as it's used as a single word in this context.
Apply this diff to fix the spelling:
- - ***beforeRequest*** Function - Before request hook, you can change every thing here. + - ***beforeRequest*** Function - Before request hook, you can change everything here.🧰 Tools
🪛 LanguageTool
[misspelling] ~74-~74: Use ‘every thing’ if you want to emphasize that the things are separate. Usually, you can use “everything”.
Context: ...n - Before request hook, you can change every thing here. - streaming Boolean - let...(EVERYTHING)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~67-~67: Possible agreement error. The noun ‘phase’ seems to be countable.
Context: ... to tell urllib use same timeout on two phase or set them separately such as `timeout...
(CD_NN)
[misspelling] ~74-~74: Use ‘every thing’ if you want to emphasize that the things are separate. Usually, you can use “everything”.
Context: ...n - Before request hook, you can change every thing here. - streaming Boolean - let...
(EVERYTHING)
🔇 Additional comments (4)
README.md (4)
65-65: LGTM! Consistent formatting applied.The formatting change to use triple asterisks for the
fixJSONCtlCharsparameter aligns with the document's style guide.
68-68: LGTM! Consistent formatting applied.The formatting change to use triple asterisks for the
keepAliveTimeoutparameter aligns with the document's style guide.
73-73: LGTM! Consistent formatting applied.The formatting change to use triple asterisks for the
formatRedirectUrlparameter aligns with the document's style guide.
75-75: LGTM! Consistent formatting applied.The formatting change to use triple asterisks for the
streamingparameter aligns with the document's style guide.
commit: |
fengmk2
changed the title
Arguments section of the documentationArguments section of the documentation
I found these somewhat distracting and figured I might as well clean the documentation up a bit:
separatelyandyourselfSummary by CodeRabbit
request()method