From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: "Siraphob (Ben) Phipathananunth" <siraben@disroot.org>
Cc: emacs-orgmode@gnu.org
Subject: Re: Org Mode Documentation Patch
Date: Sat, 23 Jun 2018 09:36:42 +0200 [thread overview]
Message-ID: <87wouquf79.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <f133412a1d773c9fcbffcf93f269afdd@disroot.org> (Siraphob Phipathananunth's message of "Sat, 23 Jun 2018 02:23:31 +0000")
Hello,
"Siraphob (Ben) Phipathananunth" <siraben@disroot.org> writes:
> I've begun reading the Org Mode manual, and noticed that the wording
> in some places could be improved (so far I've read up to Section 4.8).
> I've attached my patch. Some of the more drastic changes:
>
> - Changed all occurrences of "the cursor" to "point", I thought the
> inconsistency was confusing, especially since the Emacs manual
> maintains usage of "point" throughout, so too should the Org Mode
> manual.
Thank you. I applied your patch.
I'm not totally convinced by the change from "function" to "Lisp
function", since, in the context of Org, an Elisp library, there is no
ambiguity. But I have no strong opinion, so I didn't remove the
occurrences in your patch.
BTW, what is your status wrt FSF papers?
> Section 4.6 "Link abbreviations" in the Org Mode manual link to
> websites that have and/or promote non-free software. The URLs are
> used to illustrate link abbreviations in Org Mode, but I suppose this
> was purely coincidental because long URLs to websites such as
> gnu.org/some/long/path could be used instead. Would it be appropriate
> to change the examples in a later patch?
Sure. However, for the sake of clarity, it would be better if not all
examples are similar, i.e., no "gnu.org/some/long/path" everywhere.
> When the PDF version of the Org Mode manual is generated with "make
> docs", the footnotes (3 and 4) around Section 4.3 are incorrectly
> indented, can anyone reproduce this?
I don't see anything like that in the PDF. You may want to try deleting
it and re-generate it.
> Should I submit my patches as smaller ones as I read sections of the
> manual or bulk them together into a larger patch, or is it just a
> matter of preference?
As you wish.
> Please let me know if you have any comments about the patch. It's my
> first one, I hope I have followed the CONTRIBUTING guide properly.
I fixed a couple of missing capitalization (point at the beginning of
a sentence) and filled modified paragraphs. I also slightly modified
your commit message.
Regards,
--
Nicolas Goaziou
next prev parent reply other threads:[~2018-06-23 7:36 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-06-23 2:23 Org Mode Documentation Patch Siraphob (Ben) Phipathananunth
2018-06-23 7:36 ` Nicolas Goaziou [this message]
2018-06-23 13:28 ` Siraphob (Ben) Phipathananunth
2018-06-23 13:47 ` Nicolas Goaziou
2018-06-25 14:35 ` Siraphob (Ben) Phipathananunth
2018-06-25 14:54 ` Nicolas Goaziou
2018-06-25 16:01 ` Van L
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=87wouquf79.fsf@nicolasgoaziou.fr \
--to=mail@nicolasgoaziou.fr \
--cc=emacs-orgmode@gnu.org \
--cc=siraben@disroot.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.
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).