unofficial mirror of help-gnu-emacs@gnu.org
 help / color / mirror / Atom feed
From: Andy Moreton <andrewjmoreton@gmail.com>
To: help-gnu-emacs@gnu.org
Subject: Re: Adding document strings to a `use-package' declaration
Date: Mon, 20 Feb 2017 13:03:40 +0000	[thread overview]
Message-ID: <vz1ino53tg3.fsf@gmail.com> (raw)
In-Reply-To: 87lgt3enyc.fsf@gmail.com

On Sat 18 Feb 2017, Narendra Joshi wrote:

> Hi,
>
> Is it possible to add an extra keyword to a `use-package' declaration?
>
> For example, I would like to a small comment to a use-package
> declaration. I can add it as a comment above the declaration. I find
> adding a extra keyword, say :meta or :doc, cleaner.
>
> ,----
> | (use-package which-key
> |   :doc "Get quick Emacs key binding suggestions."
> |   :ensure t
> |   :init
> |   (setq which-key-max-description-length nil)
> |   (which-key-mode 1))
> `----

See README.md from https://github.com/jwiegley/use-package for details of how to do this.

    AndyM




  reply	other threads:[~2017-02-20 13:03 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-02-18 11:30 Adding document strings to a `use-package' declaration Narendra Joshi
2017-02-20 13:03 ` Andy Moreton [this message]
2017-02-20 14:01   ` Narendra Joshi

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=vz1ino53tg3.fsf@gmail.com \
    --to=andrewjmoreton@gmail.com \
    --cc=help-gnu-emacs@gnu.org \
    /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.
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).