Repository navigation
DOC-7262 Hide the Possible errors list for clients with no method signature - #4468
Merged
Merged
Conversation
…nature The Possible errors block that DOC-7253 added to the API Methods tab rendered after the signature if/else, so a client with no signature (redis-rs for EVALSHA) showed "No method signature available for this client." followed by an error list. The partial call now sits inside the `if $clientSigs` branch. The ticket's second option, keeping the list and rewording the empty text, was dropped because the empty-signature text is shared by every command and the list is only useful beside a signature. Checked on a full Hugo build: EVALSHA shows the list for the ten clients with signatures and none for redis_rs_sync and redis_rs_async, and SET shows it for all twelve. The page's index.html.md and index.json carry no Possible errors block, so there was nothing to change there. The ticket names ioredis as an affected client, but the dropdown has no ioredis section (Node.js maps to node_redis only), so that case could not be checked. Learned: the Possible errors block belongs only beside a rendered signature, and the dropdown has no ioredis section Constraint: api-methods-errors.html is called only inside the `if $clientSigs` branch of api-methods-tab.html Gaps: the client dropdown was not clicked through in a browser, only the rendered HTML was inspected Ticket: DOC-7262 Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Contributor
Contributor
🧠 Redis MemoryFound 5 related items from repository history (5 new this commit):
Memory updated at e683535 |
Contributor
Author
|
Thanks @dwdougherty ! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Moves the
api-methods-errors.htmlcall inside theif $clientSigsbranch ofapi-methods-tab.html, so a client with no method signature no longer shows a "Possible errors" list under "No method signature available for this client."Checked on a full Hugo build:
redis_rs_syncorredis_rs_async.index.html.mdandindex.jsonfor both commands carry no Possible errors block, so nothing changed there.The ticket names ioredis, but the API Methods dropdown has no ioredis section, so that case wasn't checked. The dropdown wasn't clicked through in a browser.
🤖 Generated with Claude Code
Note
Low Risk
Documentation template-only change with no auth, data, or runtime behavior impact.
Overview
Possible errors on command reference API Methods tabs now render only when that client has a method signature, not alongside the “No method signature available for this client.” message.
The
api-methods-errors.htmlpartial is moved from the outer client block into theif $clientSigsbranch inapi-methods-tab.html, so clients likeredis_rs_sync/redis_rs_asyncon commands such as EVALSHA no longer show an errors list without a signature. Clients with signatures are unchanged.Reviewed by Cursor Bugbot for commit e683535. Bugbot is set up for automated code reviews on this repo. Configure here.