[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/doc-toc c39306dad7 41/84: Fix docstrings with checkdoc
From: |
ELPA Syncer |
Subject: |
[elpa] externals/doc-toc c39306dad7 41/84: Fix docstrings with checkdoc (for MELPA) |
Date: |
Mon, 26 Sep 2022 13:58:37 -0400 (EDT) |
branch: externals/doc-toc
commit c39306dad79722dfcd0f07cd28e308fa2baf5a6b
Author: Daniel Nicolai <dalanicolai@gmail.com>
Commit: Daniel Nicolai <dalanicolai@gmail.com>
Fix docstrings with checkdoc (for MELPA)
---
toc-mode.el | 15 +++++++++++----
1 file changed, 11 insertions(+), 4 deletions(-)
diff --git a/toc-mode.el b/toc-mode.el
index 9e8cf67d8b..9f40b28110 100644
--- a/toc-mode.el
+++ b/toc-mode.el
@@ -220,12 +220,19 @@ Like `toc--cleanup-dots' but more suited for use after
OCR"
(interactive)
(re-search-forward "^[0-9\\.]*\\. " nil t))
-(defun toc--cleanup (startpage &optional arg)
- "Cleanup extracted Table Of Contents by running a series of cleanup
functions."
+(defun toc--cleanup (contents-page &optional arg)
+ "Cleanup extracted Table Of Contents by running a series of cleanup
functions.
+It executes the following steps:
+1. insert a Contents entry with pagenumber CONTENTS-PAGE
+2. delete subsequent lines containing the string 'contents'
+3. tries to delete redundant dots
+4. deletes lines that containi only roman numerals and linefeed characters
+5. deletes
+When ARG is non-nil it skips the last three steps"
(interactive)
(goto-char (point-min))
(when (search-forward "contents" nil t)
- (replace-match (format "Contents %s" startpage)))
+ (replace-match (format "Contents %s" contents-page)))
(toc--cleanup-lines-contents-string)
(if arg
(toc--cleanup-dots-ocr)
@@ -585,7 +592,7 @@ to `pdfoutline' shell command."
;;; djvu parse tablist to outline
(defun toc--tablist-to-djvused ()
- (interactive)
+ "Parse and prepare djvused outline source form tablist."
(let ((source-buffer doc-buffer)
(buff (get-buffer-create
(concat
- [elpa] externals/doc-toc d0cbefb88b 15/84: Update (OCR) requirements with tesseract, (continued)
- [elpa] externals/doc-toc d0cbefb88b 15/84: Update (OCR) requirements with tesseract, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 4ecb3825b9 16/84: Update README, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 5314cd0b2a 17/84: Update README, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc e6e20d2d65 20/84: Implement shift all remaining numbers and follow/preview, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc a341a6eddc 21/84: Add autoload magic comments and file-header, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 4c49867186 27/84: Fix TOC-tabular mode name and add page-scroll keybinding, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 31611d6e9f 30/84: Update LICENSE, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 8f14a2928e 31/84: Prepare package for publishing on MELPA, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc a510f530cb 33/84: Merge branch 'master' of github.com:dalanicolai/toc-mode, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 6eafd64b9e 38/84: Add # to tell compiler about function reference (for MELPA), ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc c39306dad7 41/84: Fix docstrings with checkdoc (for MELPA),
ELPA Syncer <=
- [elpa] externals/doc-toc e52b2d8ee3 44/84: Improve some (add-to-document) docstrings, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 7a436b0ca3 46/84: Remove info about limited level deepness for djvu, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 1602e353b0 49/84: Improve parsing djvu outline (prin1-to-string), ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc a11b2caa88 51/84: Add paypal donate link, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 7e50cc20d0 53/84: Implement extract-only, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 10b254ef2c 58/84: Fix auto pagenumber contents OCR, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 8c2cb1283d 60/84: Add info about pdf.tocgen alternative, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc dc5be6442f 66/84: Add jump-by-level to toc-tabular-mode, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc 06de33f511 70/84: Fix pdf-view-current-page macro not function, ELPA Syncer, 2022/09/26
- [elpa] externals/doc-toc a0018b8a63 71/84: Add replace fields in toc-tabular-mode feature, ELPA Syncer, 2022/09/26