Add 'packages/compact-docstrings/' from commit '7ada669605c4e2a9a00fa6d03da7176f2c6e3297'

[gnu-emacs-elpa] / packages / compact-docstrings / README.rst

diff --git a/packages/compact-docstrings/README.rst b/packages/compact-docstrings/README.rst
new file mode 100644 (file)
index 0000000..7a56b5a
--- /dev/null
+++ b/packages/compact-docstrings/README.rst
@@ -0,0 +1,23 @@
+=============================
+ Compact docstrings in Emacs
+=============================
+
+Shrink blank lines in docstrings and doc comments
+
+.. image:: etc/compact-docstrings.png
+
+Setup
+=====
+
+Enable locally with ``compact-docstrings-mode``::
+
+  (add-hook 'some-mode-hook #'compact-docstrings-mode)
+
+Enable globally (in all programming modes) with ``global-compact-docstrings-mode``::
+
+  (add-hook 'after-init-hook #'global-compact-docstrings-mode)
+
+Customization
+=============
+
+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``.