unofficial mirror of help-gnu-emacs@gnu.org
 help / color / mirror / Atom feed
* Adding document strings to a `use-package' declaration
@ 2017-02-18 11:30 Narendra Joshi
  2017-02-20 13:03 ` Andy Moreton
  0 siblings, 1 reply; 3+ messages in thread
From: Narendra Joshi @ 2017-02-18 11:30 UTC (permalink / raw)
  To: Gnu Emacs Help


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))
`----

-- 
Narendra Joshi



^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: Adding document strings to a `use-package' declaration
  2017-02-18 11:30 Adding document strings to a `use-package' declaration Narendra Joshi
@ 2017-02-20 13:03 ` Andy Moreton
  2017-02-20 14:01   ` Narendra Joshi
  0 siblings, 1 reply; 3+ messages in thread
From: Andy Moreton @ 2017-02-20 13:03 UTC (permalink / raw)
  To: help-gnu-emacs

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




^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: Adding document strings to a `use-package' declaration
  2017-02-20 13:03 ` Andy Moreton
@ 2017-02-20 14:01   ` Narendra Joshi
  0 siblings, 0 replies; 3+ messages in thread
From: Narendra Joshi @ 2017-02-20 14:01 UTC (permalink / raw)
  To: Andy Moreton; +Cc: help-gnu-emacs

Andy Moreton <andrewjmoreton@gmail.com> writes:

> 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
Thanks for pointing it out. I shouldn't have missed that section. :)

-- 
Narendra Joshi



^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2017-02-20 14:01 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-02-18 11:30 Adding document strings to a `use-package' declaration Narendra Joshi
2017-02-20 13:03 ` Andy Moreton
2017-02-20 14:01   ` Narendra Joshi

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).