Add documentation for how to deal with stores beyond MemoryStore
#506
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #506 +/- ##
=======================================
Coverage 99.86% 99.86%
=======================================
Files 20 20
Lines 1512 1512
Branches 415 415
=======================================
Hits 1510 1510
Misses 2 2 |
|
Great, thank you. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses a comment raised in openjournals/joss-reviews#5995. We now include documentation for how to modify the Jobflow settings to use a custom data store. This was already described in the API documentation, but now a concrete example is provided in the main documentation.
One open question: There is basically the same info in a portion of the Atomate2 documentation. Do we instead just link to it to prevent duplication of content? Or is there value in having a dedicated page with Jobflow. I can see arguments for both. In any case, this PR provides an example.