branch: externals/indent-bars
commit fa1d59893f8cfa8bae22444aa39d3f4d333224e1
Author: JD Smith <[email protected]>
Commit: JD Smith <[email protected]>
Some custom doc improvements
---
indent-bars.el | 26 +++++++++++++-------------
1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/indent-bars.el b/indent-bars.el
index d50b7e210c..5170f4884c 100644
--- a/indent-bars.el
+++ b/indent-bars.el
@@ -44,13 +44,6 @@
:group 'basic-faces
:prefix "indent-bars-")
-(defcustom indent-bars-spacing-override nil
- "Override for default, major-mode based indentation spacing.
-Set only if the default guessed spacing is incorrect."
- :local t
- :type 'integer
- :group 'indent-bars)
-
(defcustom indent-bars-width-frac 0.25
"The width of the indent bar as a fraction of the character width."
:type '(float :tag "Width Fraction"
@@ -72,8 +65,8 @@ Space signifies blank regions, and any other character
signifies
filled regions. The pattern length is scaled to match the
character height. Example: \". . \" would specify alternating
filled and blank regions each approximately one-quarter of the
-character height. Note that non-blank characters need not be the
-same (e.g., see `indent-bars-zigzag')."
+character height. Note that the non-blank characters need not be
+the same (e.g., see `indent-bars-zigzag')."
:type '(string :tag "Fill Pattern")
:group 'indent-bars)
@@ -83,7 +76,7 @@ If non-nil, an alternating zigzag offset will be applied to
consecutive groups of identical non-space characters in
`indent-bars-pattern'. Starting from the top of the pattern,
positive values will zigzag (right, left, right, ..) and negative
-values (left, right, left, ...). There is no wrap-around.
+values (left, right, left, ...).
Example:
@@ -102,9 +95,9 @@ bar pattern as follows:
| .. | zag -0.25 |.. |
Note that the pattern will be truncated at both left and right
-boundaries, so (although not required) achieving an equal zigzag
-left and right requires leaving padding on each side of the bar
-for the zig-zag; see `indent-bars-pad-frac' and
+boundaries, so (although this is not required) achieving an equal
+zigzag left and right requires leaving sufficient padding on each
+side of the bar; see `indent-bars-pad-frac' and
`indent-bars-width-frac'."
:type '(choice
(const :tag "No Zigzag" :value nil)
@@ -287,6 +280,13 @@ defaults for any missing values; see these variables."
(:zigzag (float :tag "Zig-Zag")))))
:group 'indent-bars)
+(defcustom indent-bars-spacing-override nil
+ "Override for default, major-mode based indentation spacing.
+Set only if the default guessed spacing is incorrect."
+ :local t
+ :type 'integer
+ :group 'indent-bars)
+
(defcustom indent-bars-display-on-blank-lines t
"Whether to display bars on blank lines."
:type 'boolean
