[recipe] improve recipes' comments draft
authorDavid Douard <david.douard@logilab.fr>
Tue, 21 Oct 2014 23:17:46 +0200
changeset 1738 dbf8a63bd907
parent 1737 52222f1b82d4
child 1739 50514ad06479
[recipe] improve recipes' comments
recipes.py
--- a/recipes.py	Tue Oct 21 23:16:13 2014 +0200
+++ b/recipes.py	Tue Oct 21 23:17:46 2014 +0200
@@ -3,7 +3,7 @@
 quick_script = u'''
 from checkers.apycot import python # trigger registration
 from apycotlib import narvalactions as na
-# `plan`
+# `plan` (narvalbot.engine.Plan) exists in the globals
 
 with na.apycot_environment(plan) as test:
     na.install_environment(test)
@@ -17,7 +17,7 @@
 from checkers.apycot import python # trigger registration
 from apycotlib import registered, narvalactions as na
 from apycotlib import ERROR
-# `plan`
+# `plan` (narvalbot.engine.Plan) exists in the globals
 
 with na.apycot_environment(plan) as test:
     na.install_environment(test)
@@ -36,6 +36,7 @@
 scenario_runner_script = u'''
 from checkers.apycot.scenarios import ScriptRunner
 from apycotlib import narvalactions as na
+# `plan` (narvalbot.engine.Plan) exists in the globals
 
 class ScenarioChecker(ScriptRunner):
     id = "scenario_checker"
@@ -71,7 +72,7 @@
 
 from checkers.apycot import pypi # must be first (trigger registration)
 from apycotlib import narvalactions as na
-# `plan`
+# `plan` (narvalbot.engine.Plan) exists in the globals
 
 with na.apycot_environment(plan) as test:
     test.checkout(plan)