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

Reviewer comments #257

Merged
merged 31 commits into from
Feb 9, 2024
Merged

Reviewer comments #257

merged 31 commits into from
Feb 9, 2024

Conversation

KCGallagher
Copy link
Contributor

@KCGallagher KCGallagher commented Feb 8, 2024

Changes from reviewer comments

  • Document that plot file format can be changed
  • Include separate readmes for each backend with installation instructions]
  • Incorporate backend readmes into online docs
  • List recommended compiler, and filesystem library compatibility
  • Add cEpiabm ymal so docs don't redirect to python documentation

(N.B This last change means the files on main do not match the paths expected by ReadTheDocs. However I have tested the new branches, and it builds successfully when redirected there, so this should be resolved once on main).

Copy link

codecov bot commented Feb 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (aedaf95) 100.00% compared to head (c934d10) 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #257   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          108       108           
  Lines         3690      3690           
=========================================
  Hits          3690      3690           

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

README.md Outdated Show resolved Hide resolved
cEpiabm/README.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@rccreswell rccreswell left a comment

Choose a reason for hiding this comment

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

Looks really good, we are just getting a broken link on the cEpiabm readthedocs

... inserting link_libraries(stdc++fs) in [CMakeLists.txt](cEpiabmCMakeLists.txt).

cEpiabm/README.rst Outdated Show resolved Hide resolved
cEpiabm/README.rst Outdated Show resolved Hide resolved
Co-authored-by: rccreswell <[email protected]>
@KCGallagher KCGallagher merged commit e437ca3 into main Feb 9, 2024
15 checks passed
@KCGallagher KCGallagher deleted the reviewer-comments-KG branch February 9, 2024 12:11
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.

4 participants