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

Fix #227, Add input so users can specify the parameter description #206

Merged
merged 1 commit into from
Jan 12, 2023

Conversation

HugoValente11
Copy link
Contributor

Describe the contribution
The default behavior for the param description was to be considered null. However I found this not to be very user friendly since if you didn't have the source code with the accepted values you couldn't create a valid command to send.
My solution was to add an input after specifying a parameter in order for the description of the parameter to be saved.
This way when we open GroundSystem and start creating a command to send, we have some guidelines about the acceptable inputs for the arguments

Screenshot of how the GUI has been affected:
https://ibb.co/9TKXB51

Testing performed
Steps taken to test the contribution:

  1. Parse document with CHeaderParser.py
  2. After selecting line for parameter to add, write (or not) a short description of the values that are acceptable

Expected behavior changes

  • Behavior Change: now when we open Ground System the column with the description for the params will be filled instead of the default null which makes it more user friendly

System(s) tested on

  • OS: Ubuntu 20.04

Contributor Info - All information REQUIRED for consideration of pull request
Hugo Micael Santos Valente / STRAST / UPM

@dzbaker
Copy link
Contributor

dzbaker commented Sep 8, 2022

CCB 8 September 2022: Needs an issue.

@dzbaker dzbaker self-assigned this Sep 8, 2022
@dzbaker
Copy link
Contributor

dzbaker commented Oct 11, 2022

CCB 8 September 2022: Needs an issue.

@HugoValente11 Thank you for your contribution! Would you be able to create an issue for this PR?

@HugoValente11
Copy link
Contributor Author

@HugoValente11 Thank you for your contribution! Would you be able to create an issue for this PR?

My bad, when I saw self-assigned I thought that you'd create the issue, didn't realize that you were waiting for me to create it to close the pull. Sure created it now
#227

@dzbaker dzbaker linked an issue Oct 11, 2022 that may be closed by this pull request
@dzbaker dzbaker added the CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) label Oct 11, 2022
@dzbaker
Copy link
Contributor

dzbaker commented Oct 11, 2022

@HugoValente11 Thank you for your contribution! Would you be able to create an issue for this PR?

My bad, when I saw self-assigned I thought that you'd create the issue, didn't realize that you were waiting for me to create it to close the pull. Sure created it now #227

Thanks!

@dzbaker dzbaker requested a review from chillfig October 13, 2022 18:05
Copy link
Contributor

@chillfig chillfig left a comment

Choose a reason for hiding this comment

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

Hi @HugoValente11 , would you please change the commit message to follow our cFS contribution convention?---> Fix #XYZ, SHORT_DESCRIPTION

One way to do this is to use git commit --amend (change commit message) and then git push --force from your local branch.

The final commit message may look like: "Fix #227, Add input so users can specify the parameter description

@chillfig
Copy link
Contributor

chillfig commented Oct 14, 2022

All of the checks are marked as passed, however "Error: The log was not found. It may have been deleted based on retention settings." is the error message displayed in the details of each job in the checks. This gives uncertainty if the passes are true.

@dzbaker
Copy link
Contributor

dzbaker commented Oct 20, 2022

CCB 20 October 2022: @dzbaker will attempt to re-run workflows.

@HugoValente11
Copy link
Contributor Author

Hi @HugoValente11 , would you please change the commit message to follow our cFS contribution convention?---> Fix #XYZ, SHORT_DESCRIPTION

Fixed

@HugoValente11 HugoValente11 changed the title Add input so users can specify the parameter description Fix #227, Add input so users can specify the parameter description Nov 24, 2022
@dzbaker
Copy link
Contributor

dzbaker commented Dec 8, 2022

@HugoValente11 Would you be able to rebase this with main?

@dzbaker dzbaker added CCB:Approved Indicates approval by CCB and removed CCB:Ready Pull request is ready for discussion at the Configuration Control Board (CCB) labels Jan 12, 2023
dzbaker added a commit to nasa/cFS that referenced this pull request Jan 12, 2023
*Combines:*

cFS-GroundSystem v3.0.0-rc4+dev43

**Includes:**

*cFS-GroundSystem*
- nasa/cFS-GroundSystem#206

Co-authored by: Hugo Valente <HugoValente11@users.noreply.github.com>
@dzbaker dzbaker merged commit 00aadfb into nasa:main Jan 12, 2023
dzbaker added a commit to nasa/cFS that referenced this pull request Jan 12, 2023
*Combines:*

cFS-GroundSystem v3.0.0-rc4+dev43

**Includes:**

*cFS-GroundSystem*
- nasa/cFS-GroundSystem#206

Co-authored by: Hugo Valente <HugoValente11@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCB:Approved Indicates approval by CCB community
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add parameter description
5 participants