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

Documentation: getting started to installation #687

Merged
merged 2 commits into from
Jan 22, 2024

Conversation

RemDelaporteMathurin
Copy link
Collaborator

@RemDelaporteMathurin RemDelaporteMathurin commented Jan 20, 2024

Proposed changes

I noticed that in the docs there was a confusion between "Getting started", "User guide: begginer's guide", "Installation" etc.

So I renamed "Getting started" by "Installation"

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)

Copy link

codecov bot commented Jan 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (4500c9c) 98.95% compared to head (3caa4ce) 98.95%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #687   +/-   ##
=======================================
  Coverage   98.95%   98.95%           
=======================================
  Files          58       58           
  Lines        2195     2195           
=======================================
  Hits         2172     2172           
  Misses         23       23           

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

@RemDelaporteMathurin RemDelaporteMathurin marked this pull request as ready for review January 22, 2024 14:25
Copy link
Collaborator

@jhdark jhdark left a comment

Choose a reason for hiding this comment

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

Improves clarity! sounds good to me

@RemDelaporteMathurin RemDelaporteMathurin merged commit 2ae06c1 into main Jan 22, 2024
6 checks passed
@RemDelaporteMathurin RemDelaporteMathurin deleted the getting-started branch January 22, 2024 15:22
Allentro pushed a commit to Allentro/FESTIM that referenced this pull request Feb 2, 2024
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