unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: "Kévin Le Gouguec" <kevin.legouguec@gmail.com>
To: 60366@debbugs.gnu.org
Cc: Stefan Kangas <stefankangas@gmail.com>
Subject: bug#60366: [PATCH] Simplify introduction of use-package manual
Date: Fri, 30 Dec 2022 11:00:52 +0100	[thread overview]
Message-ID: <874jtdus6j.fsf@gmail.com> (raw)
In-Reply-To: <87v8lwed4a.fsf@gmail.com> ("Kévin Le Gouguec"'s message of "Tue, 27 Dec 2022 22:43:49 +0100")

[ CC'ing StefanK, since these specific bits were authored in 2022-12-08
  "Add new use-package manual" (98e54f597e1) ]

Kévin Le Gouguec <kevin.legouguec@gmail.com> writes:

> Hello Emacs,
>
> A couple of things intrigue me in the current introduction of the
> use-package manual:
>
>> This chapter provides instructions and examples for quickly getting
>> started with use-package.  The first thing you need to do is make sure
>> that ‘use-package’ itself is loaded.  To do that, put this at the top of
>> your init file:
>> 
>>      (require 'use-package)
>> 
>>    The above makes the ‘use-macro’ available for us in the rest of your
>> init file.  In this manual, we say that each call to ‘use-macro’ is a
>> “declaration”, to highlight the declarative nature of its syntax.
> — (info "(use-package) Getting Started")
>
> (a) I don't think use-package defines anything called "use-macro";
> guessing this was supposed to read "‘use-package’ macro" instead?  I
> guess the former could be a shorthand for the latter, but it's not used
> anywhere else in the manual.
>
> (b) AFAICT use-package is autoloaded, so there should be no need for the
> user to (require 'use-package)?
>
> I've made a patch against emacs-29 to simplify this part of the manual
> according to these hypotheses.  I hope they are correct; apologies for
> the noise if not.
>
> (And even if the hypotheses are correct, I hope the patch is OK: the
> second sentence in this tentative new paragraph feels a bit disconnected
> from the first to me.  Still, I figured it was worth submitting anyway
> just to validate those hypotheses before racking more of my brain on
> optimal wording)
>
> Thanks.





  reply	other threads:[~2022-12-30 10:00 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-12-27 21:43 bug#60366: [PATCH] Simplify introduction of use-package manual Kévin Le Gouguec
2022-12-30 10:00 ` Kévin Le Gouguec [this message]
2022-12-31  9:52 ` Stefan Kangas
2022-12-31 11:42   ` Kévin Le Gouguec

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=874jtdus6j.fsf@gmail.com \
    --to=kevin.legouguec@gmail.com \
    --cc=60366@debbugs.gnu.org \
    --cc=stefankangas@gmail.com \
    /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.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

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