dice icon indicating copy to clipboard operation
dice copied to clipboard

docs(command): updated documentation for COMMAND (#836)

Open vpsinghg opened this issue 1 year ago • 7 comments

This PR aims to fix #836 with following changes

  1. Update the implementation of the evalCommandHelp method for the COMMAND HELP command to include documentation for the COMMAND INFO command. Additionally, update the corresponding unit test to reflect this change.
  2. Update the documentation for COMMAND command and its subcommands in the following structure

    Introduction

    Syntax

    Parameters

    Behavior

    Return values

    Errors

    Examples

Attachment for this change COMMAND DOC command count command getkeys COMMAND HELP COMMAND INFO COMMAND LIST

vpsinghg avatar Oct 10 '24 14:10 vpsinghg

This PR releases fix for #836 . @arpitbbhayani @JyotinderSingh @lucifercr07

vpsinghg avatar Oct 10 '24 16:10 vpsinghg

Thank you for the changes, I will be reviewing them. Meanwhile, Would it be okay to add a small description of changes you did along with some additional changes in eval.go files. This will ensure we are consistent with the structure of the PRs.

apoorvyadav1111 avatar Oct 10 '24 20:10 apoorvyadav1111

@apoorvyadav1111 We can put in same file but while changing doc for one subcommand leads to affecting other subcommand docs. But if this doesn't seem issue to you then we can merge them in single file and Following would be heading sub-headings structure.

COMMAND

Introduction

Syntax

Parameters

Behavior

Return values

Errors

Examples

COMMAND COUNT

Introduction

Syntax

Parameters

Behavior

Return values

Errors

Examples

vpsinghg avatar Oct 11 '24 04:10 vpsinghg

Hi, I think I meant different files but in the commands folder themselves. We can move away from subdirectory.

apoorvyadav1111 avatar Oct 11 '24 04:10 apoorvyadav1111

Okay Got it. Thanks for clarification. I will update the code and attach screenshot in PR description for reference.

vpsinghg avatar Oct 11 '24 04:10 vpsinghg

@apoorvyadav1111 Can you please review once again ?

vpsinghg avatar Oct 12 '24 14:10 vpsinghg

@apoorvyadav1111 I have incorporated your suggestions. Please review Thanks

vpsinghg avatar Oct 12 '24 18:10 vpsinghg

@apoorvyadav1111 I just checked there was one typo in COMMAND.md subcommands error section. it should be subcommand at the place of sucommand. typo

I’m creating a new PR. Which issue should I link it to?

vpsinghg avatar Oct 13 '24 05:10 vpsinghg