📚 DOCS: Add example for retrieve_temporary_list
#5157
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
|
Thanks for the review, @sphuber! I've added an "important" note on the type of the |
The current section on how the user can retrieve files temporarily to use during parsing doesn't contain any examples on how to use this feature. Here we add an example on how to specify the list of files to be retrieved in a temporary folder, clearly showing the `retrieve_temporary_list` attribute of the `CalcInfo`. We also add an example of how to obtain the `retrieved_temporary_folder` from the `kwargs` of the `Parser.parse()` method.
mbercx
force-pushed
the
docs/5143/retrieve-temp
branch
from
ce9da09 to
61c2ac6
Compare
|
Link to the corresponding section: |
sphuber
approved these changes
Oct 4, 2021
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 #5143
The current section on how the user can retrieve files temporarily to use
during parsing doesn't contain any examples on how to use this feature. Here
we add an example on how to specify the list of files to be retrieved in a
temporary folder, clearly showing the
retrieve_temporary_listattribute ofthe
CalcInfo. We also add an example of how to obtain theretrieved_temporary_folderfrom thekwargsof theParser.parse()method.