diff --git a/docs/exercise5.rst b/docs/exercise5.rst index affaf23e2900a1351698233ea521076a99711f2b..091c3b61e64e238235d30369cd8abac0adaa8e29 100644 --- a/docs/exercise5.rst +++ b/docs/exercise5.rst @@ -16,7 +16,7 @@ Anatomy of Firetasks All firetasks are classes derived from the ``FiretaskBase`` class. Many built-in Firetasks are available in the upstream FireWorks, such as the ``ScriptTask``, -``PyTask``, FileTransferTask. Additional firetasks can be written for both +``PyTask``, ``FileTransferTask``. Additional firetasks can be written for both generic and specific purposes. The skeleton of a Firetask looks like this:: @@ -86,7 +86,7 @@ If necessary the input data structure can be split into more than one file. The resulting workflow, which is given in **dataloader.json**, must be successfully running with no further modifications. -**Hint**: You can use the ``load()`` method from the ``json`` package to load +**Hint:** You can use the ``load()`` method from the ``json`` package to load JSON documents as list or dictionaries and then return a ``FWAction`` object with ``update_spec`` and the structure (see above example). @@ -94,13 +94,13 @@ with ``update_spec`` and the structure (see above example). Problem 5.2: Conditional Repeater Task -------------------------------------- -Write a RepeatIfLengthLesser firetask that can implement the while loop in the +Write a ``RepeatIfLengthLesser`` firetask that can implement the while loop in the script. The firetask should integrate into the workflow available in **dataloader+repeater.json** without further adaptations. -Hint: You can use the ``load_object`` function from +**Hint:** You can use the ``load_object`` function from ``fireworks.utilities.fw_serializers`` to construct a firework object and -the ``detours`` keyword argument of ``FWAction`` `to insert the firework +the ``detours`` keyword argument of ``FWAction`` to insert the firework dynamically:: firework = Firework(