Skip to content

add example usage to README#20

Merged
jhdark merged 5 commits intomainfrom
example-usage
Jun 23, 2025
Merged

add example usage to README#20
jhdark merged 5 commits intomainfrom
example-usage

Conversation

@jhdark
Copy link
Collaborator

@jhdark jhdark commented Apr 17, 2025

Proposed changes

Adding an example to the README

Types of changes

What types of changes does your code introduce to foam2dolfinx?

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Code refactoring
  • Documentation Update (if none of the other choices apply)
  • New tests

Checklist

  • Unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

@codecov
Copy link

codecov bot commented Apr 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.19%. Comparing base (754e3c4) to head (1856cf8).
Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #20   +/-   ##
=======================================
  Coverage   97.19%   97.19%           
=======================================
  Files           2        2           
  Lines         107      107           
=======================================
  Hits          104      104           
  Misses          3        3           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jhdark jhdark merged commit 4acfe5d into main Jun 23, 2025
9 checks passed
@jhdark jhdark deleted the example-usage branch June 23, 2025 20:32
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.

1 participant