emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: libreville <libreville@riseup.net>
To: Ihor Radchenko <yantar92@posteo.net>
Cc: emacs-orgmode@gnu.org
Subject: Re: Offline documentation (Org Manual info file) of org hooks is misleading
Date: Wed, 21 Jun 2023 11:17:05 +0000	[thread overview]
Message-ID: <29f9dd6385bca33ae1f3ab4beb9b8c2d@riseup.net> (raw)
In-Reply-To: <87mt0tf6w4.fsf@localhost>

[-- Attachment #1: Type: text/plain, Size: 742 bytes --]

Here's my attempt.

It's my first time doing this, so kindly let me know if there's
something I can do better!

For example, should I have replaced the subject line of this email with
the subject in the formatted .patch?


On 2023-06-21 10:26, Ihor Radchenko wrote:
> libreville <libreville@riseup.net> writes:
> 
>> Chapter A.1 Hooks of the Org Manual reads, in its entirety:
>> ...
>> Contrary to what it says, I couldn't find any illustrations of hook
>> usage in the appendix. The Variables index only refers to four, and
>> they're in other places.
>>
>> Perhaps the line about illustrating could be deleted, to avoid sending
>> people on a search for something that isn't there?
> 
> Agree.
> Would you be interested to submit a patch?

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Delete-reference-to-non-existent-examples-of-hook-us.patch --]
[-- Type: text/x-diff; name=0001-Delete-reference-to-non-existent-examples-of-hook-us.patch, Size: 981 bytes --]

From c1fda8d0162583db709c90f01df2b8678ddc7957 Mon Sep 17 00:00:00 2001
From: libreville <libreville@riseup.net>
Date: Wed, 21 Jun 2023 13:04:19 +0200
Subject: [PATCH] Delete reference to non-existent examples of hook usage.

---
 doc/org-manual.org | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index 4feb15e71..21582fe8e 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -21128,10 +21128,9 @@ of Org.
 :END:
 #+cindex: hooks
 
-Org has a large number of hook variables for adding functionality.
-This appendix illustrates using a few.  A complete list of hooks with
-documentation is maintained by the Worg project at
-https://orgmode.org/worg/doc.html#hooks.
+Org has a large number of hook variables for adding functionality.  A
+complete list of hooks with documentation is maintained by the Worg
+project at https://orgmode.org/worg/doc.html#hooks.
 
 ** Add-on Packages
 :PROPERTIES:
-- 
2.30.2


  reply	other threads:[~2023-06-21 11:18 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <mailman.0.1687332940.25718.emacs-orgmode@gnu.org>
2023-06-21  7:53 ` Offline documentation (Org Manual info file) of org hooks is misleading libreville
2023-06-21 10:26   ` Ihor Radchenko
2023-06-21 11:17     ` libreville [this message]
2023-06-21 11:35       ` Ihor Radchenko
2023-06-21 11:41         ` [PATCH] " libreville
2023-06-21 11:58           ` Ihor Radchenko
2023-06-21 11:57             ` libreville

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.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=29f9dd6385bca33ae1f3ab4beb9b8c2d@riseup.net \
    --to=libreville@riseup.net \
    --cc=emacs-orgmode@gnu.org \
    --cc=yantar92@posteo.net \
    /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/org-mode.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).