Update documentation

2020-10-01 19:16:51 -03:00 · 2020-10-01 19:16:51 -03:00 · a253e70328
commit a253e70328
parent 4df495601a
1 changed files with 1 additions and 0 deletions
--- a/docs/development/module.rst
+++ b/docs/development/module.rst
@ -11,6 +11,7 @@ Adding a new module to ``bumblebee-status`` is straight-forward:
   ``bumblebee-status`` (i.e. a module called
   ``bumblebee_status/modules/contrib/test.py`` will be loaded using
   ``bumblebee-status -m test``)
+-  The module name must follow the `Python Naming Conventions <https://www.python.org/dev/peps/pep-0008/#package-and-module-names>`_
 -  See below for how to actually write the module
 -  Test (run ``bumblebee-status`` in the CLI)
 -  Make sure your changes don’t break anything: ``./coverage.sh``