Skip to content
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.

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

Updated GETSET doc #824 #848

Merged
merged 2 commits into from
Oct 1, 2024
Merged

Updated GETSET doc #824 #848

merged 2 commits into from
Oct 1, 2024

Conversation

sashpawar11
Copy link
Contributor

@sashpawar11 sashpawar11 commented Sep 29, 2024

This PR resolves #824

Changes Made

  • Refactored headings to match as per syntax requirement in issue Audit and make documentation for command GETSET consistent #824
  • Refactored formatting for Parameters, Return values , Examples sections
  • Added 127.0.0.1:7379> in all CLI implementation examples
  • Refactored cli output error messages to reflect current CLI error message syntaxes in Examples and Errors sections
  • Refactored Behavior section to include additional step of TTL reset on keys
  • Refactored Examples section to include a new example displaying TTL reset on keys post GETSET

@sashpawar11
Copy link
Contributor Author

Hi @arpitbbhayani - please review the changes.
Thankyou

@sashpawar11 sashpawar11 changed the title Updated GETSET doc #89 Updated GETSET doc #824 Sep 29, 2024
@sashpawar11
Copy link
Contributor Author

Hey @lucifercr07 @apoorvyadav1111 @AshwinKul28 - review whenever feasible.
Thankyou.

- `value`: The new value to set for the specified key. This must be a string.
| Parameter | Description | Type | Required |
|-----------------|--------------------------------------------------|---------|----------|
| `key` | The key whose value you want to retrieve and set. | String | Yes |
Copy link
Contributor

Choose a reason for hiding this comment

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

Aren't these not aligned?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

My IDE had word-wrap toggled so i guess it added those spaces, but the render was accurate when previewed in the IDE. Attaching the preview shown on git below:
Screenshot From 2024-10-01 23-58-24

Let me know if we still need to refactor it.

@lucifercr07 lucifercr07 merged commit ff44b08 into DiceDB:master Oct 1, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Audit and make documentation for command GETSET consistent
2 participants