Emphasize that steps must be importable

Fixes #120.
aloetesting · Sep 26, 2016 · 384feff · 384feff
1 parent 20accb0
commit 384feff
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/docs/porting.rst b/docs/porting.rst
@@ -22,6 +22,8 @@ sense. However, there are following incompatible changes:
  * ``terrain.py`` has no particular significance. It will be imported but only
    if it exists at the same directory with the other step definition files, and
    not above it.
+ * Step files are loaded using the normal Python import mechanism. This means
+   the directory they are in must have a (possibly empty) `__init__.py`.
  * Scenario outlines must be declared with "Scenario Outline", and scenarios
    without examples must use "Scenario" - Lettuce allowed using either.
 

diff --git a/docs/steps.rst b/docs/steps.rst
@@ -46,6 +46,11 @@ Steps can and should be defined in separate modules to the main application
 code. Aloe searches for modules to load steps from inside the ``features``
 directories.
 
+Steps can be placed in separate files, for example,
+``features/steps/browser.py`` and ``features/steps/data.py``, but all those
+files must be importable, so this requires creating a (possibly empty)
+``features/steps/__init__.py`` alongside.
+
 Additional 3rd-party steps (such as `aloe_django`_) can be imported in from
 your ``__init__.py``.