tyler.durden
/
powerline
mirror of https://github.com/powerline/powerline.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Place labels before labeled key name, not before the description

This commit is contained in:
ZyX 2014-08-09 12:18:04 +04:00
parent f89744209f
commit 757e563250
1 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
docs/source/configuration/reference.rst
View File

@ -101,20 +101,20 @@ Common configuration is a subdictionary that is a value of ``ext`` key in
``colorscheme`` ``colorscheme``
Defines the colorscheme used for this extension. Defines the colorscheme used for this extension.
``theme`` .. _config-ext-theme:
.. _config-ext-theme:
``theme``
Defines the theme used for this extension. Defines the theme used for this extension.
``top_theme`` .. _config-ext-top_theme:
.. _config-ext-top_theme:
``top_theme``
Defines the top-level theme used for this extension. See `Themes`_ section Defines the top-level theme used for this extension. See `Themes`_ section
for more details. for more details.
``local_themes`` .. _config-ext-local_themes:
.. _config-ext-local_themes:
``local_themes``
Defines themes used when certain conditions are met, e.g. for Defines themes used when certain conditions are met, e.g. for
buffer-specific statuslines in vim. Value depends on extension used. For vim buffer-specific statuslines in vim. Value depends on extension used. For vim
it is a dictionary ``{matcher_name : theme_name}``, where ``matcher_name`` it is a dictionary ``{matcher_name : theme_name}``, where ``matcher_name``
@ -324,54 +324,54 @@ ascii Theme without any unicode characters at all
<config-themes-seg-segments>` and :ref:`args <config-themes-seg-segments>` and :ref:`args
<config-themes-seg-args>` options. <config-themes-seg-args>` options.
``module`` .. _config-themes-seg-module:
.. _config-themes-seg-module:
``module``
Function module, only required for function segments. Defaults to Function module, only required for function segments. Defaults to
``powerline.segments.{extension}``. Default is overriden by ``powerline.segments.{extension}``. Default is overriden by
:ref:`default_module theme option <config-themes-default_module>`. :ref:`default_module theme option <config-themes-default_module>`.
``name`` .. _config-themes-seg-name:
.. _config-themes-seg-name:
``name``
Function name, only required for function and list segments. Function name, only required for function and list segments.
``highlight_group`` .. _config-themes-seg-highlight_group:
.. _config-themes-seg-highlight_group:
Highlighting group for this segment. Consists of a prioritized list ``highlight_group``
of highlighting groups, where the first highlighting group that is Highlighting group for this segment. Consists of a prioritized list of
highlighting groups, where the first highlighting group that is
available in the colorscheme is used. available in the colorscheme is used.
Ignored for segments that have ``function`` type. Ignored for segments that have ``function`` type.
``before`` .. _config-themes-seg-before:
.. _config-themes-seg-before:
``before``
A string which will be prepended to the segment contents. A string which will be prepended to the segment contents.
``after`` .. _config-themes-seg-after:
.. _config-themes-seg-after:
``after``
A string which will be appended to the segment contents. A string which will be appended to the segment contents.
``contents`` .. _config-themes-seg-contents:
.. _config-themes-seg-contents:
``contents``
Segment contents, only required for ``string`` segments. Segment contents, only required for ``string`` segments.
``args`` .. _config-themes-seg-args:
.. _config-themes-seg-args:
``args``
A dict of arguments to be passed to a ``function`` segment. A dict of arguments to be passed to a ``function`` segment.
``align`` ``align``
Aligns the segments contents to the left (``l``), center (``c``) or Aligns the segments contents to the left (``l``), center (``c``) or
right (``r``). right (``r``).
``width`` .. _config-themes-seg-width:
.. _config-themes-seg-width:
``width``
Enforces a specific width for this segment. Enforces a specific width for this segment.
This segment will work as a spacer if the width is set to ``auto``. This segment will work as a spacer if the width is set to ``auto``.
@ -412,13 +412,13 @@ ascii Theme without any unicode characters at all
A list of modes where this segment will be included: The segment is A list of modes where this segment will be included: The segment is
*not* included in any modes, *except* for the modes in this list. *not* included in any modes, *except* for the modes in this list.
``display`` .. _config-themes-seg-display:
.. _config-themes-seg-display:
``display``
Boolean. If false disables displaying of the segment. Boolean. If false disables displaying of the segment.
Defaults to ``True``. Defaults to ``True``.
``segments`` .. _config-themes-seg-segments:
.. _config-themes-seg-segments:
``segments``
A list of subsegments. A list of subsegments.