branch: externals/topspace
commit ccc5c23731a87004884b4496da1a6f4229594f79
Author: Trevor Pogue <pogu...@mcmaster.ca>
Commit: Trevor Pogue <pogu...@mcmaster.ca>
Update description
---
README.md | 13 ++++---------
test/topspace-test.el | 8 ++++----
topspace.el | 13 +++++++++----
3 files changed, 17 insertions(+), 17 deletions(-)
diff --git a/README.md b/README.md
index 6f26ddd1a8..6304a36a3e 100644
--- a/README.md
+++ b/README.md
@@ -21,19 +21,14 @@
<a href="https://github.com/trevorpogue/topspace#extra-functions";> Extra
functions</a> |
<a href="https://github.com/trevorpogue/topspace#how-it-works";> How it
works </a> ]
-TopSpace is an Emacs minor mode that
-provides the ability to scroll down the first line of a buffer
-to be below the top of the window with blank lines drawn above it,
-allowing the first line to be displayed in the center of the window
-as if it weren't the first line.
+TopSpace is an Emacs minor mode that lets you display a buffer's first line in
the center of a window instead of just at the top.
This is done by automatically drawing an upper margin/padding above line 1
-as you recenter and scroll down top text, without modifying the
-underlying file.
+as you recenter and scroll it down.
### Features
* **Easier on the eyes**: Recenter or scroll down top text to a more
comfortable eye level for reading, especially when in full-screen or on a large
monitor.
-* **Easy to use**: No new keybindings are required, keep using all your
previous scrolling & recentering commands, except now you can also scroll above
the top lines. It also integrates seamlessly with [centered-cursor-mode][1] to
keep the cursor centered all the way to the top line.
+* **Easy to use**: No new keybindings are required, keep using all your
previous scrolling & recentering commands, except now you can also scroll down
the first line. It also integrates seamlessly with [centered-cursor-mode][1]
to keep the cursor centered all the way to the top line.
# Installation
@@ -58,7 +53,7 @@ To enable `topspace-mode` globally on startup, add the
following to your Emacs c
```
# Usage
### Just enable and go
-No new keybindings are required, keep using all your previous scrolling &
recentering commands, except now you can also scroll above the top lines.
+No new keybindings are required, keep using all your previous scrolling &
recentering commands, except now you can also scroll down the first line.
# Customization
```elisp
diff --git a/test/topspace-test.el b/test/topspace-test.el
index 258d3d6cf8..3670a198ca 100644
--- a/test/topspace-test.el
+++ b/test/topspace-test.el
@@ -200,7 +200,7 @@ by default"
;; :to-equal
;; (line-number-at-pos (point-max)))))
- (it "can count lines"
+ (it "can count lines'"
(set-window-start (selected-window) 300)
(expect (round (topspace--count-lines (window-start)
(topspace--window-end)))
@@ -211,15 +211,15 @@ by default"
(it "can count lines if start is larger than end"
(set-window-start (selected-window) 300)
(expect (round (topspace--count-lines 401 201))
- :to-equal 3)
+ :to-equal 4)
(expect (round (topspace--count-lines 201 401))
- :to-equal 3)
+ :to-equal 4)
(set-window-start (selected-window) 1))
(it "can count lines if window-absolute-pixel-position returns nil"
(expect (round (round (topspace--count-lines 201 401)))
:to-equal
- 3)))
+ 4)))
(describe
"topspace--correct-height"
diff --git a/topspace.el b/topspace.el
index 63d967f736..fc3c90d817 100644
--- a/topspace.el
+++ b/topspace.el
@@ -1,4 +1,4 @@
-;;; topspace.el --- Scroll down & recenter line 1 to be below the top of the
window using upper margin/padding -*- lexical-binding: t -*-
+;;; topspace.el --- Recenter line 1 with scrollable upper margin/padding -*-
lexical-binding: t -*-
;; Copyright (C) 2021-2022 Free Software Foundation, Inc.
@@ -34,7 +34,12 @@
;; as you recenter and scroll down top text, without modifying the
;; underlying file.
-;; See https://github.com/trevorpogue/topspace for a gif demo & documentation.
+;; TopSpace lets you display a buffer's first line in the center of a window
+;; instead of just at the top.
+;; This is done by automatically drawing an upper margin/padding above line 1
+;; as you recenter and scroll it down.
+
+;; See https://github.com/trevorpogue/topspace for a GIF demo & documentation.
;; Features:
@@ -44,7 +49,7 @@
;; - Easy to use: No new keybindings are required, keep using all
;; your previous scrolling & recentering commands, except now you
-;; can also scroll above the top lines. It also integrates
+;; can also scroll down the first line. It also integrates
;; seamlessly with `centered-cursor-mode' to keep the cursor
;; centered all the way to the top line.
@@ -772,7 +777,7 @@ Topspace will not be enabled for:
;;;###autoload
(define-minor-mode topspace-mode
- "Scroll down & recenter line 1 to be below the top of the window.
+ "Recenter line 1 with scrollable upper margin/padding.
TopSpace provides the ability to scroll down the first line of a buffer
to be below the top of the window with blank lines drawn above it,
