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

Parse argument label of commands #118

Open
jmmabanta opened this issue Aug 30, 2022 · 0 comments · May be fixed by #122
Open

Parse argument label of commands #118

jmmabanta opened this issue Aug 30, 2022 · 0 comments · May be fixed by #122
Assignees
Labels
enhancement New feature or request low priority Nice to have functionality

Comments

@jmmabanta
Copy link
Contributor

Brief Feature Description

ex2_ground_station_software now has labels describing what each command argument is (see here for example). It would be helpful to operators if these arguments are labelled in the help menu so that they know what each of them do.

Additional Details

The labels are the args dictionary keys, while the value is their expected data type. Since it might be cluttered if we show both the label and datatype, we should only show the keys (label) since they are be descriptive enough.

As many API endpoints rely on the num_arguments field in the Telecommands model, keep it as it is and instead add a new column storing these labels.
- Although PostgreSQL supports SQL Arrays, sqlite3 does not (which we still use for unit tests). An idea I have in storing these labels would just be a single string with the labels separated by a comma (eg. 'arg1,arg2,arg3,...'). We can then separate these when rendering the webpage

Once added, argument labels can also be used in AutomatedCommands and Flightschedule to label the argument text boxes, instead of having 'Argument 1', 'Argument 2', etc. as labels.

Priority

Low

@jmmabanta jmmabanta added enhancement New feature or request low priority Nice to have functionality labels Aug 30, 2022
@jmmabanta jmmabanta changed the title Parse argument information of commands Parse argument label of commands Aug 30, 2022
@gurbirsandha gurbirsandha self-assigned this Aug 30, 2022
@gurbirsandha gurbirsandha linked a pull request Sep 1, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request low priority Nice to have functionality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants