emacs-orgmode
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[O] Org Mode Documentation Patch


From: Siraphob (Ben) Phipathananunth
Subject: [O] Org Mode Documentation Patch
Date: Sat, 23 Jun 2018 02:23:31 +0000

This patch was originally submitted to Emacs devel, but Eli Zaretskii
redirected me here.

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.

I have a couple of questions regarding the Org Mode manual and
submitting patches:

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?

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?  What is causing 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?

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.

Thanks!

--

Siraphob (Ben) Phipathananunth

Attachment: 0001-Fix-various-grammatical-errors-and-fix-terminology.patch
Description: Binary data


reply via email to

[Prev in Thread] Current Thread [Next in Thread]