l.behm/bumblebee-status
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update documentation

Browse source
This commit is contained in:
Thaynã Moretti 2020-10-01 19:16:51 -03:00
parent 4df495601a
commit a253e70328
1 changed files with 1 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/development/module.rst
View file

@ -11,6 +11,7 @@ Adding a new module to ``bumblebee-status`` is straight-forward:
``bumblebee-status`` (i.e. a module called ``bumblebee-status`` (i.e. a module called
``bumblebee_status/modules/contrib/test.py`` will be loaded using ``bumblebee_status/modules/contrib/test.py`` will be loaded using
``bumblebee-status -m test``) ``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 - See below for how to actually write the module
- Test (run ``bumblebee-status`` in the CLI) - Test (run ``bumblebee-status`` in the CLI)
- Make sure your changes don’t break anything: ``./coverage.sh`` - Make sure your changes don’t break anything: ``./coverage.sh``