Skip to content

Commit

Permalink
style: tweak some formatting in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aravinda0 committed Aug 15, 2024
1 parent e60d1f2 commit 08f656f
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@ Click on the image to open a web view with the full guide.
| Option Name | Default Value | Description |
| --- | --- | --- |
|`length` | 500 | The standard `length` property of qtile<br>widgets.<br><br>As usual, it can be a fixed integer, or<br>one of the 'special' bar constants:<br>`bar.CALCULATED` or `bar.STRETCH`. |
|`sync_with` | bonsai_on_same_screen | The Bonsai layout whose state should be<br>rendered on this widget.<br><br>Can be one of the following:<br>&nbsp;&nbsp;&nbsp;&nbsp;- "bonsai_with_focus":<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The Bonsai layout of the window<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;that is currently focused. This<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;is relevant in a multi-screen<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;setup - the widget will keep<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;updating based on which screen's<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Bonsai layout has focus.<br>&nbsp;&nbsp;&nbsp;&nbsp;- "bonsai_on_same_screen":<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The widget will stick to<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;displaying the state of the<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Bonsai layout that is on the<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;same screen as the widget's bar. |
|`sync_with` | bonsai_on_same_screen | The Bonsai layout whose state should be<br>rendered on this widget.<br><br>Can be one of the following:<br>&nbsp;&nbsp;&nbsp;&nbsp;- `bonsai_with_focus`:<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The Bonsai layout of the window<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;that is currently focused. This<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;is relevant in a multi-screen<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;setup - the widget will keep<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;updating based on which screen's<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Bonsai layout has focus.<br>&nbsp;&nbsp;&nbsp;&nbsp;- `bonsai_on_same_screen`:<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The widget will stick to<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;displaying the state of the<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Bonsai layout that is on the<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;same screen as the widget's bar. |
|`bg_color` | None | Background color of the bar.<br>If None, the qtile-bar's' background<br>color is used. |
|`font_family` | Mono | Font family to use for tab titles |
|`font_size` | 15 | Size of the font to use for tab titles |
Expand Down
4 changes: 2 additions & 2 deletions src/qtile_bonsai/widget.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,11 @@ class BonsaiBar(base._Widget):
The Bonsai layout whose state should be rendered on this widget.
Can be one of the following:
- "bonsai_with_focus":
- `bonsai_with_focus`:
The Bonsai layout of the window that is currently focused. This is
relevant in a multi-screen setup - the widget will keep updating
based on which screen's Bonsai layout has focus.
- "bonsai_on_same_screen":
- `bonsai_on_same_screen`:
The widget will stick to displaying the state of the Bonsai layout
that is on the same screen as the widget's bar.
""",
Expand Down

0 comments on commit 08f656f

Please sign in to comment.