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

Docs fixes #797

Merged
merged 10 commits into from
Jul 4, 2024
Merged

Docs fixes #797

merged 10 commits into from
Jul 4, 2024

Conversation

RemDelaporteMathurin
Copy link
Collaborator

@RemDelaporteMathurin RemDelaporteMathurin commented Jul 4, 2024

Proposed changes

We noticed some bugs in the API section of the docs in #791

Also take the opportunity to remove the numbering from the user guide and other docs improvements.

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

Copy link

codecov bot commented Jul 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.55%. Comparing base (dd40851) to head (eef4c44).
Report is 135 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #797   +/-   ##
=======================================
  Coverage   99.55%   99.55%           
=======================================
  Files          61       61           
  Lines        2705     2705           
=======================================
  Hits         2693     2693           
  Misses         12       12           

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

@KulaginVladimir
Copy link
Collaborator

Maybe, you could also add indents to Note (I suppose, should be Notes) here and here?

@RemDelaporteMathurin RemDelaporteMathurin changed the title Fix docs api Docs fixes Jul 4, 2024
@RemDelaporteMathurin RemDelaporteMathurin added this to the v1.3 milestone Jul 4, 2024
@RemDelaporteMathurin RemDelaporteMathurin mentioned this pull request Jul 4, 2024
15 tasks
@RemDelaporteMathurin
Copy link
Collaborator Author

@KulaginVladimir anything else to add? or are we good to merge this?

@RemDelaporteMathurin RemDelaporteMathurin merged commit 66d2e25 into main Jul 4, 2024
6 checks passed
@RemDelaporteMathurin RemDelaporteMathurin deleted the fix-docs-api branch July 11, 2024 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants