Skip to content

added argument labels to help page#122

Open
gurbirsandha wants to merge 2 commits into
masterfrom
gurbirsandha/enhancement/command_arg_labels
Open

added argument labels to help page#122
gurbirsandha wants to merge 2 commits into
masterfrom
gurbirsandha/enhancement/command_arg_labels

Conversation

@gurbirsandha
Copy link
Copy Markdown
Contributor

I'm not sure if we wanted similar thing for what each command returns. Could be displayed in the same sort of way on help page

@gurbirsandha gurbirsandha linked an issue Sep 1, 2022 that may be closed by this pull request
Copy link
Copy Markdown
Contributor

@jmmabanta jmmabanta left a comment

Choose a reason for hiding this comment

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

Looks good! Only needs a slight change in the help UI to make it more intuitive (moving the command list to be inside the parenthesis next to the command instead of num_arguments).

If it wouldn't take to much time, adding the return value labels to the help menu would also be good.

Lastly, can you also update the argument boxes in AutomatedCommands and Flightschedule so that they are labelled correctly (instead of Argument 1, Argument 2, etc.)

{command.about_info != null ? (
<p style={{ paddingLeft: '5%' }}>{command.about_info}</p>
) : null}
{command.arg_labels != null ? (
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we move the argument list to replace the 'number of arguments' field next to the command name (so it looks like what you would type in).

eg. housekeeping.get_hk(Limit, Before_id, Before_time) instead of housekeeping.get_hk (3)

We can then have this format for return values instead.

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.

Parse argument label of commands

2 participants