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

Restructure Documentation and publish #126

Merged
merged 8 commits into from
Jul 25, 2024
Merged

Restructure Documentation and publish #126

merged 8 commits into from
Jul 25, 2024

Conversation

jmborr
Copy link
Member

@jmborr jmborr commented Jul 23, 2024

References

  • EWM #

Description of the changes:

Manual test for the reviewer

(instructions to set up the environment)

Start RefRed GUI

(refred-dev)> PYTHONPATH=$(pwd):$PYTHONPATH ./scripts/start_refred.py

Or run tests

(refred-dev)> pytest test/unit/RefRed/test_main.py

Check list for the reviewer

  • I have verified the proposed changes
  • Author included tests for the proposed changes
  • best software practices
    • clearly named variables (better to be verbose in variable names)
    • code comments explaining the intent of code blocks
    • new functions and classes detailed docstrings, parameters documented
  • All tests are passing
  • Documentation is up to date

Check list for the author

  • I have added tests for my changes
  • I have updated the documentation accordingly
  • I included a link to IBM EWM Story or Defect

Signed-off-by: Jose Borreguero <borreguero@gmail.com>
@codecov-commenter
Copy link

codecov-commenter commented Jul 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.52%. Comparing base (5cced0e) to head (2745503).

Additional details and impacted files
@@           Coverage Diff           @@
##             next     #126   +/-   ##
=======================================
  Coverage   60.52%   60.52%           
=======================================
  Files         121      121           
  Lines       10129    10129           
=======================================
  Hits         6131     6131           
  Misses       3998     3998           

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

jmborr added 4 commits July 22, 2024 20:36
Signed-off-by: Jose Borreguero <borreguero@gmail.com>
Signed-off-by: Jose Borreguero <borreguero@gmail.com>
Signed-off-by: Jose Borreguero <borreguero@gmail.com>
Signed-off-by: Jose Borreguero <borreguero@gmail.com>
@jmborr jmborr changed the title Restructure Documentation an publish Restructure Documentation and publish Jul 25, 2024
jmborr added 3 commits July 25, 2024 12:50
Signed-off-by: Jose Borreguero <borreguero@gmail.com>
Signed-off-by: Jose Borreguero <borreguero@gmail.com>
Signed-off-by: Jose Borreguero <borreguero@gmail.com>
@jmborr jmborr merged commit 5ee9435 into next Jul 25, 2024
3 checks passed
@jmborr jmborr deleted the harmonize_docs branch July 25, 2024 18:18
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.

2 participants