8000 Docs: use plus signs for commands with links. by nightroman · Pull Request #1175 · microsoft/garnet · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Docs: use plus signs for commands with 8000 links. #1175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Apr 20, 2025
Merged

Docs: use plus signs for commands with links. #1175

merged 1 commit into from
Apr 20, 2025

Conversation

nightroman
Copy link
Contributor

This PR fixes new inconsistencies at the command compatibility page. Namely, commands UNBLOCK, GETKEYS, GETKEYSANDFLAGS are implemented and correctly have links to documentation details but they are not marked with the "➕" sign. They look "not implemented", in other words.

As far as this issue is recurring (e.g. #785 and #757) I have added the docs test that catches such issues. Namely, without the above fix, the test would fail with this message:

Command UNBLOCK: remove the docs link or use the '➕' sign.
Command GETKEYS: remove the docs link or use the '➕' sign.
Command GETKEYSANDFLAGS: remove the docs link or use the '➕' sign.

@Copilot Copilot AI review requested due to automatic review settings April 19, 2025 06:48
Copilot
Copilot AI reviewed Apr 19, 2025
View reviewed changes
Copy link
Contributor
@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request addresses documentation inconsistencies on the command compatibility page by ensuring that commands with implemented links, including UNBLOCK, GETKEYS, and GETKEYSANDFLAGS, are correctly marked with the "➕" sign. Additionally, a new docs test has been added to catch any future mismatches in this behavior.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
website/docs/commands/api-compatibility.md Updated command sign markers from "➖" to "➕" for specific commands.
test/Garnet.test/DocsTests.cs Added a docs test using regex to ensure commands with links display "➕".

@nightroman
Copy link
Contributor Author

I am not sure what to do with one test failure, it does not look related to my change (adding a new test)

Garnet (ubuntu-latest, net8.0, Debug, Garnet.test.cluster)

Failed Garnet.test.cluster.ClusterMigrateTests(False).ClusterMigrateSlotWalk(True) [1 m 40 s]
Error Message:
 Cancellation Requested
Stack Trace:
   at Garnet.test.cluster.ClusterTestUtils.BackOff(CancellationToken cancellationToken, TimeSpan timeSpan, String msg) in /_/test/Garnet.test.cluster/ClusterTestUtils.cs:line 594
 at Garnet.test.cluster.ClusterMigrateTests.<ClusterMigrateSlotWalk>g__MigrateSlots|44_4(<>c__DisplayClass44_0&, <>c__DisplayClass44_1&, <>c__DisplayClass44_2&) in /_/test/Garnet.test.cluster/ClusterMigrateTests.cs:line 1849
 at Garnet.test.cluster.ClusterMigrateTests.ClusterMigrateSlotWalk(Boolean slots, CancellationToken cancellationToken) in /_/test/Garnet.test.cluster/ClusterMigrateTests.cs:line 1784

@badrishc badrishc merged commit 83b202a into microsoft:main Apr 20, 2025
26 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Jun 20, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

Copilot code review Copilot Copilot left review comments

@badrishc badrishc badrishc approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nightroman @badrishc
0