From: "Clément Pit--Claudel" <clement.pit@gmail.com>
To: Emacs developers <emacs-devel@gnu.org>
Cc: Stefan Monnier <monnier@iro.umontreal.ca>
Subject: [ELPA] New package: compact-docstrings
Date: Sun, 26 Jun 2016 13:30:42 -0400 [thread overview]
Message-ID: <57701142.1040001@gmail.com> (raw)
[-- Attachment #1.1.1: Type: text/plain, Size: 893 bytes --]
Hi emacs-devel,
As a follow-up to the recent discussion on docstring styles (see https://lists.gnu.org/archive/html/emacs-devel/2016-05/msg00240.html), I just pushed the attached package to scratch/compact-docstrings (this is my first push to ELPA, so please excuse potential mistakes).
This very simple package defines a `compact-docstrings-mode' mode mode. When activated, empty lines in docstrings and doc comments are displayed in a different font (currently defaulting to half-height). In practice, this shrinks white space in docstrings to save space, while still clearly separating consecutive paragraphs. The development of this package was suggested by Stefan; I've been using it for about a week now, and it works pretty well for me.
The github page at https://github.com/cpitclaudel/compact-docstrings has a screenshot.
Opinions and advice welcome!
Cheers,
Clément.
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.1.2: compact-docstrings.el --]
[-- Type: text/x-emacs-lisp; name="compact-docstrings.el", Size: 3501 bytes --]
;;; compact-docstrings.el --- Shrink blank lines in docstrings and doc comments
;; Copyright (C) 2016 Free Software Foundation, Inc.
;; Author: Clément Pit-Claudel <clement.pitclaudel@live.com>
;; Maintainer: Clément Pit-Claudel <clement.pitclaudel@live.com>
;; URL: https://github.com/cpitclaudel/compact-docstrings
;; Package-Version: 0.1
;; Keywords: convenience, faces, lisp, maint, c
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; Shrink blank lines in docstrings and doc comments
;;
;; Enable locally with `compact-docstrings-mode':
;; (add-hook 'some-mode-hook #'compact-docstrings-mode)
;;
;; Enable globally (in all programming modes) with
;; (add-hook 'after-init-hook #'global-compact-docstrings--mode)
;;; Code:
(defgroup compact-docstrings nil
"Shrink empty lines in docstrings and doc comments."
:group 'faces)
(defface compact-docstrings-face
'((t :height 0.5))
"Face applied to blank lines in docstrings."
:group 'compact-docstrings)
(defcustom compact-docstrings-only-doc-blocks t
"When nil, also shrink blank lines in regular strings and comments."
:group 'compact-docstrings
:type 'boolean)
(defun compact-docstrings--matcher (bound)
"Find blank line in docstring, looking in point .. BOUND."
(let ((found nil))
(while (and (not found) (re-search-forward "^\\s-*\n" bound t))
(let ((syntax (syntax-ppss)))
(when (and (or (nth 3 syntax) ;; In string
(nth 4 syntax)) ;; In comment
(or (not compact-docstrings-only-doc-blocks)
(let ((face (get-text-property (point) 'face)))
(or (eq face 'font-lock-doc-face)
(and (listp face) (memq 'font-lock-doc-face face))))))
(setq found t))))
found))
(defconst compact-docstrings--keywords
'((compact-docstrings--matcher 0 'compact-docstrings-face prepend)) 'append)
;;;###autoload
(define-minor-mode compact-docstrings-mode
"Shrink empty lines in docstrings and doc comments."
:lighter " compact"
(if compact-docstrings-mode
(font-lock-add-keywords nil compact-docstrings--keywords 'append)
(font-lock-remove-keywords nil compact-docstrings--keywords))
(if (fboundp #'font-lock-flush)
(font-lock-flush)
(with-no-warnings (font-lock-fontify-buffer))))
(defun compact-docstrings--mode-on ()
"Turn on `compact-docstrings-mode', if appropriate."
(when (derived-mode-p major-mode #'prog-mode)
(compact-docstrings-mode)))
;;;###autoload
(defalias 'shrink-docstrings #'compact-docstrings--mode-on)
;;;###autoload
(define-globalized-minor-mode global-compact-docstrings-mode compact-docstrings-mode
compact-docstrings--mode-on
:init-value nil)
(provide 'compact-docstrings)
;;; compact-docstrings.el ends here
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 836 bytes --]
next reply other threads:[~2016-06-26 17:30 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-06-26 17:30 Clément Pit--Claudel [this message]
2016-06-29 13:31 ` [ELPA] New package: compact-docstrings Clément Pit--Claudel
2016-06-29 15:00 ` Artur Malabarba
2016-06-29 15:12 ` Clément Pit--Claudel
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=57701142.1040001@gmail.com \
--to=clement.pit@gmail.com \
--cc=emacs-devel@gnu.org \
--cc=monnier@iro.umontreal.ca \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).