docs(command): updated documentation for COMMAND (#836)
This PR aims to fix #836 with following changes
- Update the implementation of the
evalCommandHelpmethod for theCOMMAND HELPcommand to include documentation for the COMMAND INFO command. Additionally, update the corresponding unit test to reflect this change. - Update the documentation for
COMMANDcommand and its subcommands in the following structureIntroduction
Syntax
Parameters
Behavior
Return values
Errors
Examples
Attachment for this change
This PR releases fix for #836 . @arpitbbhayani @JyotinderSingh @lucifercr07
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 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
Hi, I think I meant different files but in the commands folder themselves. We can move away from subdirectory.
Okay Got it. Thanks for clarification. I will update the code and attach screenshot in PR description for reference.
@apoorvyadav1111 Can you please review once again ?
@apoorvyadav1111 I have incorporated your suggestions. Please review Thanks
@apoorvyadav1111 I just checked there was one typo in COMMAND.md subcommands error section.
it should be subcommand at the place of sucommand.
I’m creating a new PR. Which issue should I link it to?