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

adding documentation #4

Merged
merged 1 commit into from
Aug 23, 2024
Merged

adding documentation #4

merged 1 commit into from
Aug 23, 2024

Conversation

jmborr
Copy link
Member

@jmborr jmborr commented Aug 23, 2024

Description of the changes

Check all that apply:

  • added release notes (if not, provide an explanation in the work description)
  • updated documentation
  • Source added/refactored
  • Added unit tests
  • Added integration tests

References:

  • Links to IBM EWM items:
  • Links to related issues or pull requests:

Manual test for the reviewer

Check list for the reviewer

  • release notes updated, or an explanation is provided as to why release notes are unnecessary
  • best software practices
    • 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

Signed-off-by: Jose Borreguero <[email protected]>
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.51%. Comparing base (22a3afd) to head (2168894).

Additional details and impacted files
@@           Coverage Diff           @@
##             next       #4   +/-   ##
=======================================
  Coverage   89.51%   89.51%           
=======================================
  Files           3        3           
  Lines         124      124           
=======================================
  Hits          111      111           
  Misses         13       13           

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

@jmborr jmborr merged commit 8333c48 into next Aug 23, 2024
1 check passed
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