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

[doc] slightly extend HOWTO_MODULE

Browse source
This commit is contained in:
tobi-wan-kenobi 2020-05-03 11:21:11 +02:00
parent 368d5de171
commit 421d365d8d
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/HOWTO_MODULE.md
View file

@ -10,6 +10,7 @@ Adding a new module to `bumblebee-status` is straight-forward:
- 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`
- If you want to do me favour, run your module through `black -t py34` before submitting
## Pull requests ## Pull requests
The project **gladly** accepts PRs for bugfixes, new functionality, new The project **gladly** accepts PRs for bugfixes, new functionality, new
@ -56,6 +57,14 @@ Otherwise, you have a number of ways to handle widgets:
- During runtime, you can set a new list of widgets by using the `self.widgets(<new list>)` - During runtime, you can set a new list of widgets by using the `self.widgets(<new list>)`
method of the module method of the module
## Adding widgets at runtime
If you want to add widgets during runtime, please use the `add_widget()` method of the module:
```
def do_something(self):
self.add_widget(full_text="my sample text", name="<optional name>")
```
TODO: expand on this TODO: expand on this
## Periodic updates ## Periodic updates