Skip to content

Commit

Permalink
Apply user suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
mbercx committed Oct 4, 2021
1 parent d4b1db2 commit 61c2ac6
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/source/topics/calculations/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -542,6 +542,12 @@ This folder is then passed under the ``retrieved_temporary_folder`` keyword argu
retrieved_temporary_folder = kwargs['retrieved_temporary_folder']
The parser implementation can then parse these files and store the relevant information as output nodes.
.. important::
The type of ``kwargs['retrieved_temporary_folder']`` is a simple ``str`` that represents the `absolute` filepath to the temporary folder.
You can access its contents with the ``os`` standard library module or convert it into a ``pathlib.Path``.
After the parser terminates, the engine will automatically clean up the sandbox folder with the temporarily retrieved files.
The concept of the ``retrieve_temporary_list`` is essentially that the files will be available during parsing and will be destroyed immediately afterwards.
Expand Down

0 comments on commit 61c2ac6

Please sign in to comment.