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

Update install docs #345

Merged
merged 2 commits into from
Nov 7, 2024
Merged

Update install docs #345

merged 2 commits into from
Nov 7, 2024

Conversation

alexvalentine94
Copy link
Collaborator

Description

Minor update to installation docs.

Fixes #343

Type of change

Please select what type of change this is.

  • Bug fix (non-breaking change which fixes an issue)
  • New benchmark
    • Non-breaking change which entirely uses exisiting classes, structure etc
    • Breaking change which has implemented new/modified classes etc
  • New feature
    • Non-breaking change which adds functionality
    • Breaking change fix or feature that would cause existing functionality to not work as expected

Other changes

  • This change requires a documentation update
  • (If Benchmark) This requires additional data that can be obtained from:
    • Benchmark data 1
    • Benchamrk data 2

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • General testing
    • New and existing unit tests pass locally with my changes
    • Coverage is >80%

Copy link

codecov bot commented Nov 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

@dodu94 dodu94 self-requested a review November 6, 2024 15:48
@dodu94 dodu94 merged commit e16ca60 into developing Nov 7, 2024
9 checks passed
@dodu94 dodu94 deleted the update-install-docs branch November 7, 2024 15:37
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.

2 participants