masq/i3pystatus
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Module: Add hyperlinks to hints docstring.

Browse Source
This commit is contained in:
Lukáš Mandák 2015-06-18 20:39:28 +02:00
parent 3d0142b74d
commit 0267454557
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
i3pystatus/core/modules.py
View File

@ -29,17 +29,18 @@ class Module(SettingsBase):
Blocks will be applied only if `self.output` does not contain a block with
the same name already.
All blocks are described in i3bar protocol documentation located at
http://i3wm.org/docs/i3bar-protocol.html#_blocks_in_detail.
It is recommended to use only the following blocks:
All blocks are described in `i3bar protocol documentation
<http://i3wm.org/docs/i3bar-protocol.html#_blocks_in_detail>`_
but it is recommended to use only the following blocks:
* `min_width` and `align` blocks are used to set minimal width of output and
text aligment if text width is shorter than minimal width.
* `separator` and `separator_block_width` blocks are used to remove the
vertical bar that is separating modules.
* `markup` block can be set to `"none"` or `"pango"`.
Pango is a markup language providing additional formatting options
to advanced users.
`Pango markup
<https://developer.gnome.org/pango/stable/PangoMarkupFormat.html>`_
provides additional formatting options for advanced users.
"""