Docs: move in the documentation on caching #4228
Merged
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
sphuber
force-pushed
the
fix/3988/docs-caching
branch
5 times, most recently
from
cf8b9fe to
a91a35c
Compare
csadorf
suggested changes
Jul 10, 2020
docs/source/howto/run_codes.rst
Outdated
|
|
||
| `#3988`_ | ||
| Finally, while caching saves unnecessary computations, it does not save disk space: The output nodes of the cached calculation are full copies of the original outputs. |
There was a problem hiding this comment.
Is there any reason that this is shown as separate paragraph instead of just another bullet point?
There was a problem hiding this comment.
Don't think so. Will include as bullet point
The content is mostly moved in from existing content, just adapting the style to the new guidelines.
Split off the technical details to a Topics section. I put it under the "Provenance" topic, as I don't think it needs its own top level section. Even though caching only applies to calculation jobs at the moment, and so one could argue to place it there, really this is a current implementation detail and this is explained in the limitations. Since it has fundamentally to do with the provenance, I think this is the best fit. Finally, I put an `important` block at the beginning of the how-to to explain why it is not enabled by default and to warn users of the caveats, which links to the topics section.
sphuber
force-pushed
the
fix/3988/docs-caching
branch
from
a91a35c to
1ce8f94
Compare
|
Thanks for the review @csadorf . I have addressed the simple comments and split off the details to a Topics section, and added a disclaimer. See commit message for reasoning of location of new section. |
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.
Fixes #3988
The content is mostly moved in from existing content, just adapting the
style to the new guidelines.