diff options
| author | Paul Nelson <ultrono@gmail.com> | 2025-04-02 15:19:01 +0200 |
|---|---|---|
| committer | Paul Nelson <ultrono@gmail.com> | 2025-04-02 15:19:01 +0200 |
| commit | e8deea855f470a931354f4c8280fb2ecfb04c588 (patch) | |
| tree | 1dd4e4c6eb45d31f2c421de4d75618e7f9d7d081 | |
| parent | c5dad4fd8d7285f31c038f17e9a7100e05377174 (diff) | |
Improve docstring of doc-follow-modes variable
* doc-follow.el (doc-follow-modes): Reformat and clarify the docstring.
| -rw-r--r-- | doc-follow.el | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/doc-follow.el b/doc-follow.el index 4d06e17..1951039 100644 --- a/doc-follow.el +++ b/doc-follow.el @@ -54,13 +54,14 @@ :current (lambda () (pdf-view-current-page)) :max (lambda () (pdf-cache-number-of-pages)))) "Alist of supported major modes and relevant functions. -Each entry has the format: -(MAJOR-MODE - :goto GOTO-PAGE-FUNCTION - :next NEXT-PAGE-FUNCTION - :prev PREV-PAGE-FUNCTION - :current FUNCTION-RETURNING-CURRENT-PAGE - :max FUNCTION-RETURNING-MAX-PAGE) +Each entry has the format: (MAJOR-MODE . CONFIG), where CONFIG is a list +with entries: + +:goto GOTO-PAGE-FUNCTION +:next NEXT-PAGE-FUNCTION +:prev PREV-PAGE-FUNCTION +:current FUNCTION-RETURNING-CURRENT-PAGE +:max FUNCTION-RETURNING-MAX-PAGE Other packages can add support for additional document viewing modes by adding entries to this list.") |