Update cli-client.md #616
Update cli-client.md #616
Conversation
WalkthroughThe documentation for the CLI Client has been updated to reflect a change in the command for retrieving a greeting from the API. The command has been modified from Changes
Suggested reviewers
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 (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
docs/docs/tutorial/cli-client.md (1)
64-64: Approved: Command update improves clarity.The change from
get-greetingtoget-greeting-by-nameis correct and aligns with the PR objectives. This update makes the command more specific and clearer about its functionality.Consider adding a brief explanation about this change, such as:
See the help commands like `restish tutorial --help` or `restish tutorial get-greeting-by-name --help` for more details. If you set up command-line completion, you can also use tab to see all available commands. +Note: The `get-greeting` command has been renamed to `get-greeting-by-name` to better reflect its functionality.This addition would help users understand the change if they're familiar with the previous version of the documentation.
| {{ asciinema("../../terminal/restish-call.cast", rows="20") }} | ||
|
|
||
| See the help commands like `restish tutorial --help` or `restish tutorial get-greeting --help` for more details. If you set up command-line completion, you can also use tab to see all available commands. | ||
| See the help commands like `restish tutorial --help` or `restish tutorial get-greeting-by-name --help` for more details. If you set up command-line completion, you can also use tab to see all available commands. |
There was a problem hiding this comment.
💡 Codebase verification
Inconsistent OperationID references found in documentation
Several instances of get-greeting remain in OperationID fields across multiple markdown files. Please update them to get-greeting-by-name to ensure consistency throughout the documentation.
docs/docs/tutorial/writing-tests.md: OperationID: "get-greeting"docs/docs/tutorial/sending-data.md: OperationID: "get-greeting"docs/docs/tutorial/your-first-api.md: OperationID: "get-greeting"docs/docs/tutorial/service-configuration.md: OperationID: "get-greeting"docs/docs/tutorial/client-sdks.md: OperationID: "get-greeting"docs/docs/how-to/oauth2-jwt.md: OperationID: "get-greeting"docs/docs/how-to/graceful-shutdown.md: OperationID: "get-greeting"docs/docs/features/auto-patch.md: OperationID: "get-greeting"docs/docs/features/openapi-generation.md: OperationID: "get-greeting"
🔗 Analysis chain
Verify consistency across documentation
The command change from get-greeting to get-greeting-by-name might affect other parts of the documentation not visible in this file.
Please run the following script to check for any remaining instances of get-greeting in the documentation:
If any instances are found, please update them to maintain consistency across the documentation.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Search for any remaining instances of 'get-greeting' in markdown files
# Test: Search for 'get-greeting' in markdown files. Expect: No results or only in change history.
rg --type md 'get-greeting' docs/
Length of output: 957
| {{ asciinema("../../terminal/restish-call.cast", rows="20") }} | ||
|
|
||
| See the help commands like `restish tutorial --help` or `restish tutorial get-greeting --help` for more details. If you set up command-line completion, you can also use tab to see all available commands. | ||
| See the help commands like `restish tutorial --help` or `restish tutorial get-greeting-by-name --help` for more details. If you set up command-line completion, you can also use tab to see all available commands. |
There was a problem hiding this comment.
@alexanderilyin hmm, if you look at https://huma.rocks/tutorial/your-first-api/#__codelineno-8-29 and follow the tutorial it will indeed be called get-greeting, but if you skip that step you can wind up with the wrong command name that is auto-generated. 🤔
|
My bad. It does seem that I missed a step actually. |
Typo in
.castalso should be updated.Summary by CodeRabbit
restish tutorial get-greeting --helptorestish tutorial get-greeting-by-name --help.