Skip to content

Commit 960c5ca

Browse files
committed
Reflect changes to customization variable docstrings
1 parent 512893f commit 960c5ca

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,19 @@ Bonus: If you use [`centered-cursor-mode`][1], this means that `topspace` will a
1818
```
1919
(defcustom topspace-autocenter-buffers
2020
t
21-
"Vertically center small buffers when first opened or window sizes change."
21+
"Vertically center small buffers when first opened or window sizes change.
22+
23+
This is done by automatically calling `topspace-recenter-buffer',
24+
which adds enough top space to center small buffers.
25+
Top space will not be added if the number of text lines in the buffer is larger
26+
than or close to the selected window's height.
27+
Customize `topspace-center-position' to adjust the centering position."
2228
:group 'topspace
2329
:type 'boolean)
2430
2531
(defcustom topspace-center-position
2632
0.5
27-
"Suggested position when centering buffers as a ratio of frame height.
33+
"Target position when centering buffers as a ratio of frame height.
2834
A value from 0 to 1 where lower values center buffers higher up in the screen.
2935
3036
Used in `topspace-recenter-buffer' when called or when opening/resizing buffers

0 commit comments

Comments
 (0)