summaryrefslogtreecommitdiff
path: root/lisp/use-package/bind-key.el
diff options
context:
space:
mode:
authorAdam Spiers <emacs@adamspiers.org>2014-01-06 12:38:00 +0000
committerAdam Spiers <emacs@adamspiers.org>2014-01-06 13:57:55 +0000
commit2dbee4cd751cabe6cddcb5cccdc833d58d109b21 (patch)
tree39875956812b0cd0a9d14cfe6b8daea3d7e0ae1f /lisp/use-package/bind-key.el
parent25ea8ea840b69b62c436f1cbed85a824cfc92221 (diff)
downloademacs-2dbee4cd751cabe6cddcb5cccdc833d58d109b21.tar.gz
emacs-2dbee4cd751cabe6cddcb5cccdc833d58d109b21.tar.bz2
emacs-2dbee4cd751cabe6cddcb5cccdc833d58d109b21.zip
fix DRY violation by only having documentation in one place
The documentation in README.md was previously identical to that in the Commentary section of use-package.el, modulo the following differences: - No elisp comment ";; " prefix - Code blocks indented 4 columns not 2, as required by Markdown - Elisp symbols marked in backtick delimiters for monospace, not emacs backtick/forward tick pairs. Unfortunately due to this duplication, sometimes only one of the two files got updated, so they got out of sync. With us all being human, this is likely to continue to happen as long as the duplication exists ;-) Therefore since most users are likely to encounter README.md before the elisp, and bearing in mind that Markdown is a much more flexible format for documentation than elisp comments (richer formatting, can be exported to numerous other formats etc.), it is better to replace the docs in use-package.el with a pointer to the README.md.
Diffstat (limited to 'lisp/use-package/bind-key.el')
0 files changed, 0 insertions, 0 deletions