-
Notifications
You must be signed in to change notification settings - Fork 1
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 tutorial documentation to mention need to delete old files #551
Update tutorial documentation to mention need to delete old files #551
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #551 +/- ##
========================================
Coverage 95.01% 95.01%
========================================
Files 74 74
Lines 4235 4235
========================================
Hits 4024 4024
Misses 211 211 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Both the text to remind users to delete previously generated folder and example bash code to do so worked well, thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jacobcook1995 That's basically fine. The only thing we could say is that the example is (now) setup to always using the explicit out
directory. So we could be a bit cleaner and do the install step once and then get people to delete out
(or rename it) if they want to run things again. The advantage of this is it sets people up to do repeated runs from the example data so that they can play around with comparing tweaks to the config etc. etc. rather than just nuking everything and starting from an empty clean copy.
Description
This adds to the example run documentation to mention that files from previous runs need to be deleted otherwise errors can crop up. I thought the easiest way to do that was just to tell users to delete the old directory and install a new one (rather than listing specific files that could be problematic). Let me know if you think this is sensible and whether you think that the flow is okay!
Fixes #543
Type of change
Key checklist
pre-commit
checks:$ pre-commit run -a
$ poetry run pytest
Further checks