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

#825: audited and made SDIFF docs consistent | added build fail fix ( Echo doc error ) #913

Merged
merged 2 commits into from
Oct 2, 2024

Conversation

rishavvajpayee
Copy link
Contributor

changes

This PR updates the documentation for the SDIFF command in DiceDB to improve clarity, consistency, and structure. Key changes include: ( this takes reference from the SET documentation )

  • The return values and Parameters are replaced with a detailed conditions table for successful and error scenarios and paramters with types.
  • Commands written in examples are now displayed in the bash instead of plan text. with defined127.0.0.1:7379> as prefix.
  • Overall structure and headings were audited to match the flow of SET Documentation
  • The build error in Echo due to InvalidContentEntryFormatterError was resolved. Added 'the' before teh ECHO as a fix. Any other changes in the Echo files were due to formatter.

@lucifercr07
Copy link
Contributor

@rishavvajpayee please resolve conflicts

Copy link
Collaborator

@JyotinderSingh JyotinderSingh left a comment

Choose a reason for hiding this comment

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

Thanks for the fixes and contributions @rishavvajpayee! LGTM.

@rishavvajpayee
Copy link
Contributor Author

i see that @JyotinderSingh merged master into my branch. I see no conflicts @lucifercr07. But i see the build failing due to tests failing.

@JyotinderSingh
Copy link
Collaborator

i see that @JyotinderSingh merged master into my branch. I see no conflicts @lucifercr07. But i see the build failing due to tests failing.

unrelated test failure.

@JyotinderSingh JyotinderSingh merged commit 61c1530 into DiceDB:master Oct 2, 2024
1 of 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.

3 participants