Skip to content

Commit f2a29e2

Browse files
sebastinassebastinas
committed
Reformat
Signed-off-by: Sebastian Ramacher <[email protected]>
1 parent 023ebe8 commit f2a29e2

1 file changed

Lines changed: 33 additions & 28 deletions

File tree

‎doc/sphinx/source/configuration-options.rst‎

Lines changed: 33 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
General
22
-------
3-
This refers to the ``[general]`` section in your `$XDG_CONFIG_HOME/bpython/config` file.
3+
This refers to the ``[general]`` section in your
4+
`$XDG_CONFIG_HOME/bpython/config` file.
45

56
auto_display_list
67
^^^^^^^^^^^^^^^^^
@@ -9,10 +10,9 @@ When this is off, you can hit tab to see the suggestions.
910

1011
autocomplete_mode
1112
^^^^^^^^^^^^^^^^^
12-
There are three modes for autocomplete. simple, substring, and fuzzy.
13-
Simple matches methods with a common prefix, substring matches methods with a common
14-
subsequence, and fuzzy matches methods with common characters (default:
15-
simple).
13+
There are three modes for autocomplete. simple, substring, and fuzzy. Simple
14+
matches methods with a common prefix, substring matches methods with a common
15+
subsequence, and fuzzy matches methods with common characters (default: simple).
1616

1717
.. versionadded:: 0.12
1818

@@ -22,7 +22,8 @@ Syntax highlighting as you type (default: True).
2222

2323
arg_spec
2424
^^^^^^^^
25-
Display the arg spec (list of arguments) for callables, when possible (default: True).
25+
Display the arg spec (list of arguments) for callables, when possible (default:
26+
True).
2627

2728
hist_file
2829
^^^^^^^^^
@@ -42,8 +43,8 @@ Soft tab size (default 4, see pep-8)
4243

4344
pastebin_url
4445
^^^^^^^^^^^^
45-
The pastebin url to post to (without a trailing slash). This pastebin has
46-
to be a pastebin which uses LodgeIt. Examples are: http://paste.pocoo.org/xmlrpc/ and
46+
The pastebin url to post to (without a trailing slash). This pastebin has to be
47+
a pastebin which uses LodgeIt. Examples are: http://paste.pocoo.org/xmlrpc/ and
4748
http://bpaste.net/xmlrpc/ (default: http://bpaste.net/xmlrpc/)
4849

4950
pastebin_private
@@ -55,20 +56,23 @@ Default: True).
5556

5657
pastebin_show_url
5758
^^^^^^^^^^^^^^^^^
58-
The url under which the new paste can be reached. ``$paste_id`` will be
59-
replaced by the ID of the new paste. Examples are: http://bpaste.net/show/$paste_id/
60-
and http://paste.pocoo.org/show/$paste_id/ (default: http://bpaste.net/show/$paste_id/)
59+
The url under which the new paste can be reached. ``$paste_id`` will be replaced
60+
by the ID of the new paste. Examples are: http://bpaste.net/show/$paste_id/ and
61+
http://paste.pocoo.org/show/$paste_id/ (default:
62+
http://bpaste.net/show/$paste_id/)
6163

6264
pastebin_helper
6365
^^^^^^^^^^^^^^^
6466

6567
The name of a helper executable that should perform pastebin upload on bpython's
66-
behalf. If set, this overrides `pastebin_url`. It also overrides `pastebin_show_url`,
67-
as the helper is expected to return the full URL to the pastebin as the first word of
68-
its output. The data is supplied to the helper via STDIN.
68+
behalf. If set, this overrides `pastebin_url`. It also overrides
69+
`pastebin_show_url`, as the helper is expected to return the full URL to the
70+
pastebin as the first word of its output. The data is supplied to the helper via
71+
STDIN.
6972

7073
An example helper program is ``pastebinit``, available for most systems. The
71-
following helper program can be used to create `gists <http://gist.github.com>`_:
74+
following helper program can be used to create `gists
75+
<http://gist.github.com>`_:
7276

7377
.. code-block:: python
7478
@@ -117,12 +121,8 @@ color_scheme
117121
^^^^^^^^^^^^
118122
See :ref:`themes` for more information.
119123

120-
Color schemes should be put in ``$XDG_CONFIG_HOME/bpython/``
121-
122-
e.g to use the theme ``$XDG_CONFIG_HOME/bpython/foo.theme`` set ``color_scheme = foo``
123-
124-
If you set the colorscheme to `foo` this will be translated to
125-
``$XDG_CONFIG_HOME/bpython/foo.theme`` so be sure to put the file in that directory.
124+
Color schemes should be put in ``$XDG_CONFIG_HOME/bpython/``. For example, to
125+
use the theme ``$XDG_CONFIG_HOME/bpython/foo.theme`` set ``color_scheme = foo``
126126

127127
Leave blank or set to "default" to use the default (builtin) theme.
128128

@@ -138,11 +138,13 @@ Whether to append ``.py`` to the filename while saving the input to a file.
138138

139139
Keyboard
140140
--------
141-
This section refers to the ``[keyboard]`` section in your ``$XDG_CONFIG_HOME/bpython/config``.
141+
This section refers to the ``[keyboard]`` section in your
142+
``$XDG_CONFIG_HOME/bpython/config``.
142143

143-
You can set various keyboard shortcuts to be used by bpython. However, we have yet to map all keys
144-
to their respective control codes. If you configure a key combination which is not yet supported
145-
by bpython it will raise an exception telling you the key does not exist in bpython.keys.
144+
You can set various keyboard shortcuts to be used by bpython. However, we have
145+
yet to map all keys to their respective control codes. If you configure a key
146+
combination which is not yet supported by bpython it will raise an exception
147+
telling you the key does not exist in bpython.keys.
146148

147149
Valid keys are:
148150

@@ -251,7 +253,8 @@ Trims lines starting with '>>> ' when set to True.
251253

252254
GTK
253255
---
254-
This refers to the ``[gtk]`` section in your `$XDG_CONFIG_HOME/bpython/config` file.
256+
This refers to the ``[gtk]`` section in your `$XDG_CONFIG_HOME/bpython/config`
257+
file.
255258

256259
font
257260
^^^^
@@ -270,10 +273,12 @@ fill_terminal
270273
^^^^^^^^^^^^^
271274
Default: False
272275

273-
Whether bpython should clear the screen on start, and always display a status bar at the bottom.
276+
Whether bpython should clear the screen on start, and always display a status
277+
bar at the bottom.
274278

275279
list_above
276280
^^^^^^^^^^
277281
Default: False
278282

279-
When there is space above the current line, whether the suggestions list will be displayed there instead of below the current line.
283+
When there is space above the current line, whether the suggestions list will be
284+
displayed there instead of below the current line.

0 commit comments

Comments
 (0)