Document GUI Standards.

[searscr]

Description of Changes:

Document GUI standards with some examples.

Related Items

To Test:

cd /path/to/my/local/garnet/repo/
git fetch origin pull/<PULL_REQUEST_NUMBER>/head:pr<PULL_REQUEST_NUMBER>
git switch pr<PULL_REQUEST_NUMBER>
conda activate <garnet_environment>
python -m pytest <item_to_test>

Check list for the pull request

• I have read the [CONTRIBUTING]
• I have read the [CODE_OF_CONDUCT]
• I have added tests for my changes
• I have updated the documentation accordingly

---

Check list for the reviewer

• I have read the [CONTRIBUTING]
• I have verified the proposed changes
• best software practices
  • all internal functions have an underbar, as is python standard
  • clearly named variables (better to be verbose in variable names)
  • code comments explaining the intent of code blocks
• All the tests are passing
• The documentation is up to date
• code comments added when explaining intent

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 93.75000% with 6 lines in your changes are missing coverage. Please review.

Project coverage is 88.82%. Comparing base (02245df) to head (0a709dc).

Files	Patch %	Lines
src/garnet/home/view.py	92.45%	4 Missing ⚠️
src/garnet/helpers/ui_elements/base_lineedit.py	95.45%	1 Missing ⚠️
src/garnet/helpers/ui_elements/base_statusbar.py	95.23%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             next       #7      +/-   ##
==========================================
+ Coverage   84.09%   88.82%   +4.73%     
==========================================
  Files           7        9       +2     
  Lines          88      179      +91     
==========================================
+ Hits           74      159      +85     
- Misses         14       20       +6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[mpatrou]

user

[hetrickjm]

I recommend renaming the section called Algorithm Input Validation to something more like Data Input Validation. I like that there are two types of validation

1. Field validation which focuses on making sure what the user entered into the field is correct for the filed type. and
2. Validating the data itself.

It is not clear that all data entered by a user will be directly used in an algorithm. I would prefer a more generic term for this type of validation and not focus (limit) it to algorithms.

Error Handling, perhaps better would be visual error handling. This is not the error handling strategy, but more how to inform the user when something goes wrong. We should add a link in here to the Error Handling strategy (I think this is being covered by loggging).

[mpatrou]

please create a folder called utility and inside create another called UIelements or similar; include the base_lineedit.py and base_statusbar.py there.

[mpatrou]

works as expected