From a253e703280d836f57997980ba0ef80f57b5e56b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thayn=C3=A3=20Moretti?= Date: Thu, 1 Oct 2020 19:16:51 -0300 Subject: [PATCH] Update documentation --- docs/development/module.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/development/module.rst b/docs/development/module.rst index 1d6e716..113a6f7 100644 --- 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 `_ - 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``