festim-dev / FESTIM

Coupled hydrogen/tritium transport and heat transfer modelling using FEniCS
https://festim.readthedocs.io/en/stable/
Apache License 2.0
90 stars 23 forks source link

Test documentation code blocks #780

Closed RemDelaporteMathurin closed 3 months ago

RemDelaporteMathurin commented 3 months ago

Proposed changes

This is closing #718 by making use of doctest to test code blocks in the documentation. That will make the docs more reliable in the future as changes will be found immediately! Plus it helped fixing existing issues in the documentation.....

Types of changes

What types of changes does your code introduce to FESTIM?

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 99.53%. Comparing base (36da67b) to head (48842dd). Report is 175 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #780 +/- ## ======================================= Coverage 99.53% 99.53% ======================================= Files 59 59 Lines 2577 2577 ======================================= Hits 2565 2565 Misses 12 12 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.