branch: externals/topspace
commit 23ad7729db796a38eae6133bc2626069f78cdcc1
Author: Trevor Pogue <pogu...@mcmaster.ca>
Commit: Trevor Pogue <pogu...@mcmaster.ca>
Update description
---
README.md | 4 ++--
topspace.el | 34 +---------------------------------
2 files changed, 3 insertions(+), 35 deletions(-)
diff --git a/README.md b/README.md
index 6304a36a3e..7267ca1736 100644
--- a/README.md
+++ b/README.md
@@ -267,8 +267,8 @@ scrolling."
# How it works
The "upper margin" is created by drawing an
[overlay](https://www.gnu.org/software/emacs/manual/html_node/elisp/Overlays.html)
before
-window-start containing newline characters. As you scroll above the
-top line, more newline characters are added or removed accordingly.
+window-start containing newline characters. As you scroll down the
+first line, more newline characters are added or removed accordingly.
No new keybindings are required as topspace automatically works for
any commands or subsequent function calls which use `scroll-up`,
diff --git a/topspace.el b/topspace.el
index 250d2d9ae6..ec2fa02f73 100644
--- a/topspace.el
+++ b/topspace.el
@@ -43,23 +43,7 @@
;; your previous scrolling & recentering commands, except now you
;; 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.
-
-;; How it works:
-
-;; The "upper margin" is created by drawing an overlay before
-;; window-start containing newline characters. As you scroll above the
-;; top line, more newline characters are added or removed accordingly.
-
-;; No new keybindings are required as topspace automatically works for
-;; any commands or subsequent function calls which use `scroll-up',
-;; `scroll-down', or `recenter' as the underlying primitives for
-;; scrolling. This includes all scrolling commands/functions available
-;; in Emacs as far as the author is aware. This is achieved by using
-;; `advice-add' with the `scroll-up', `scroll-down', and `recenter'
-;; commands so that custom topspace functions are called before or after
-;; each time any of these other commands are called (interactively or
-;; otherwise).
+;; centered all the way to the first line.
;;; Code:
@@ -790,22 +774,6 @@ Features:
seamlessly with `centered-cursor-mode' to keep the cursor
centered all the way to the top line.
-How it works:
-
-The \"upper margin\" is created by drawing an overlay before
-window-start containing newline characters. As you scroll above the
-top line, more newline characters are added or removed accordingly.
-
-No new keybindings are required as topspace automatically works for
-any commands or subsequent function calls which use `scroll-up',
-`scroll-down', or `recenter' as the underlying primitives for
-scrolling. This includes all scrolling commands/functions available
-in Emacs as far as the author is aware. This is achieved by using
-`advice-add' with the `scroll-up', `scroll-down', and `recenter'
-commands so that custom topspace functions are called before or after
-each time any of these other commands are called (interactively or
-otherwise).
-
Enabling/disabling:
When called interactively, toggle `topspace-mode'.
