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

UPD of developer's guide and docs for materials #930

Merged

Conversation

KulaginVladimir
Copy link
Collaborator

Proposed changes

Updates docs according to #884, #852, and #841

@RemDelaporteMathurin, let me know how the docs could be improved

Types of changes

What types of changes does your code introduce to FESTIM?

  • 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

  • Black formatted
  • 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...

@KulaginVladimir KulaginVladimir added this to the 1.4 milestone Dec 17, 2024
Copy link

codecov bot commented Dec 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.55%. Comparing base (463b00b) to head (775ca3c).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #930   +/-   ##
=======================================
  Coverage   99.55%   99.55%           
=======================================
  Files          60       60           
  Lines        2725     2725           
=======================================
  Hits         2713     2713           
  Misses         12       12           

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

Copy link
Collaborator

@RemDelaporteMathurin RemDelaporteMathurin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for this Vladimir! Grinding towards 1.4!!

docs/source/devguide/index.rst Outdated Show resolved Hide resolved
docs/source/devguide/index.rst Outdated Show resolved Hide resolved
docs/source/devguide/index.rst Outdated Show resolved Hide resolved
docs/source/devguide/index.rst Show resolved Hide resolved
docs/source/devguide/index.rst Outdated Show resolved Hide resolved
docs/source/userguide/materials.rst Outdated Show resolved Hide resolved
docs/source/userguide/materials.rst Outdated Show resolved Hide resolved
docs/source/userguide/materials.rst Outdated Show resolved Hide resolved
@KulaginVladimir KulaginVladimir merged commit 04c8888 into festim-dev:main Dec 18, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants