[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/topspace a0aa7b9b07 066/181: Remove checkdoc warnings
From: |
ELPA Syncer |
Subject: |
[elpa] externals/topspace a0aa7b9b07 066/181: Remove checkdoc warnings |
Date: |
Tue, 23 Aug 2022 12:58:34 -0400 (EDT) |
branch: externals/topspace
commit a0aa7b9b07674e1e6b21a30081dc1bea01690250
Author: Trevor Pogue <poguete@mcmaster.ca>
Commit: Trevor Pogue <poguete@mcmaster.ca>
Remove checkdoc warnings
---
topspace.el | 34 +++++++++++++++-------------------
1 file changed, 15 insertions(+), 19 deletions(-)
diff --git a/topspace.el b/topspace.el
index 546b2ddfb2..9b72508cba 100644
--- a/topspace.el
+++ b/topspace.el
@@ -1,4 +1,4 @@
-;;; topspace.el --- Scroll down and recenter top lines, upper margin/padding
-*- lexical-binding: t -*-
+;;; topspace.el --- Scroll down & recenter top lines, get upper
margins/padding -*- lexical-binding: t -*-
;; Copyright (C) 2021-2022 Trevor Edwin Pogue
@@ -26,28 +26,26 @@
;; Scroll down and recenter top lines.
;; - Easier on the eyes: Recenter or scroll down top text to a more
-;; comfortable eye level for reading, especially if in full-screen
+;; 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 to keep the cursor
+;; can also scroll above the top lines. It also integrates
+;; seamlessly with `centered-cursor-mode' to keep the cursor
;; centered all the way to the top line.
;; How it works:
;; A top margin is created above the top text line as you scroll down
-;; top text. The \"margin\" is created by drawing an overlay before
-;; window-start containing newline characters. As you scroll above the
+;; top text. The "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. It also integrates
-;; seamlessly with `centered-cursor-mode' to keep the cursor centered
-;; all the way to the top line.
+;; `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.
;;; Code:
@@ -430,28 +428,26 @@ Topspace will not be enabled for:
"Scroll down and recenter top lines.
- Easier on the eyes: Recenter or scroll down top text to a more
- comfortable eye level for reading, especially if in full-screen
+ 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 to keep the cursor
+ can also scroll above the top lines. It also integrates
+ seamlessly with `centered-cursor-mode' to keep the cursor
centered all the way to the top line.
How it works:
A top margin is created above the top text line as you scroll down
-top text. The \"margin\" is created by drawing an overlay before
+top text. The \"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
+`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. It also integrates
-seamlessly with `centered-cursor-mode' to keep the cursor centered
-all the way to the top line.
+in Emacs as far as the author is aware.
Enabling/disabling:
When called interactively, toggle variable `topspace-mode'.
- [elpa] externals/topspace 6ed32d2426 162/181: Update NEWS.md, (continued)
- [elpa] externals/topspace 6ed32d2426 162/181: Update NEWS.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 97c2216b72 167/181: Update .elpaignore, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 28f3792bf3 159/181: Internal refactoring, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 8d44371ff0 002/181: Create LICENSE, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 3e24bc6657 003/181: Initial code commit, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 903f45bb4a 056/181: Update issue templates, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace dbcbf2c25a 059/181: Update bug_report.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 334fecd4c4 068/181: Update description in topspace.el and readme.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace c1e4621a11 067/181: Update description in topspace.el and readme.md, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace ac2e2c2cdb 072/181: Mention to follow Elisp style guides, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace a0aa7b9b07 066/181: Remove checkdoc warnings,
ELPA Syncer <=
- [elpa] externals/topspace b305bb56be 078/181: Add HISTORY.md containing legacy changelog, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 270b4ace51 069/181: Update changelog for v0.1.2, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 9d3125c0ec 081/181: Test automatic changelog generation action, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 45b44cf17c 084/181: Add automatic changelog generation action, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 8309cd98ab 096/181: Private refactoring & minor improvements, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace d4615f82f8 098/181: Update Changelog, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 3fa532a343 100/181: Fix terminal bug from PR #10, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 8fcd11d4a5 113/181: Fix mwheel mouse scrolling down bug causes by #11, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace c5b424788f 116/181: Update Changelog, ELPA Syncer, 2022/08/23
- [elpa] externals/topspace 9760a3ab5e 123/181: Update Changelog, ELPA Syncer, 2022/08/23