Documentation for modules

tobi-wan-kenobi / bumblebee-status

bumblebee-status is a modular, theme-able status line generator for the i3 window manager.

https://bumblebee-status.readthedocs.io/en/main/

MIT License

1.2k stars 229 forks source link

Documentation for modules #998

Closed PrabhuUdurg closed 9 months ago

PrabhuUdurg commented 9 months ago

Feature Request

Hello! Currently, I'm using the Pomodoro module with your status bar and was thinking of implementing audio notification. Besides this, I was thinking of writing a little documentation about how to change work and rest time for people who don't want to deep into the configs. This small documentation also can be added to the main documentation website, under the module https://bumblebee-status.readthedocs.io/en/latest/

Let me know if it's a good idea to work on!!!

tobi-wan-kenobi commented 9 months ago

sounds great and would be much appreciated!

You just need to update the docstring in the module, the module docs are autogenerated from there.

Cheers!

PrabhuUdurg commented 9 months ago

Okay! I'll start working. Happy Hacktober!