code.delx.au - gnu-emacs-elpa/blob - packages/compact-docstrings/README.rst

   1 =============================
   2  Compact docstrings in Emacs
   3 =============================
   4
   5 Shrink blank lines in docstrings and doc comments
   6
   7 .. image:: etc/compact-docstrings.png
   8
   9 Setup
  10 =====
  11
  12 Enable locally with ``compact-docstrings-mode``::
  13
  14   (add-hook 'some-mode-hook #'compact-docstrings-mode)
  15
  16 Enable globally (in all programming modes) with ``global-compact-docstrings-mode``::
  17
  18   (add-hook 'after-init-hook #'global-compact-docstrings-mode)
  19
  20 Customization
  21 =============
  22
  23 Enable compaction of all comments and strings by setting ``compact-docstrings-only-doc-blocks`` to ``nil``.  Change the compact line height by customizing ``compact-docstrings-face``.