[PATCH] org: fix symbol names and grammar in docstrings

[PATCH] org: fix symbol names and grammar in docstrings

[gerard.vermeulen]

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

Hi,

The docstrings of `org-outline-level' and `org-current-level' contain
the undefined symbol name `org-odd-levels'.

The same lines of the docstrings contain also wording like
"Unlike to `org-current-level'" and "Unlike to `org-outline-level'"
  where "to" should not be there.

This patch changes the symbol names to `org-odd-levels-only' and
removes the "to" typos.

Regards -- Gerard

[-- Attachment #2: 0001-org-fix-symbol-names-and-grammar-in-docstrings.patch --]
[-- Type: application/octet-stream, Size: 1485 bytes --]

From 5bfbb4d8427b4dbe742eae9058dc111c669955df Mon Sep 17 00:00:00 2001
From: Gerard Vermeulen <gerard.vermeulen@posteo.net>
Date: Sat, 1 Jul 2023 06:49:26 +0200
Subject: [PATCH] org: fix symbol names and grammar in docstrings

* lisp/org.el (org-outline-level):
* lisp/org.el (org-current-level): change undefined symbol names
  to `org-odd-levels-only' and change "Unlike to" to "Unlike".
---
 lisp/org.el | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/lisp/org.el b/lisp/org.el
index fdb920864..cca7e500b 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -5711,7 +5711,7 @@ highlighting was done, nil otherwise."
 
 If this is called at a normal headline, the level is the number
 of stars.  Use `org-reduced-level' to remove the effect of
-`org-odd-levels'.  Unlike to `org-current-level', this function
+`org-odd-levels-only'.  Unlike `org-current-level', this function
 takes into consideration inlinetasks."
   (org-with-wide-buffer
    (end-of-line)
@@ -6645,7 +6645,7 @@ headings in the region."
   "Return the level of the current entry, or nil if before the first headline.
 The level is the number of stars at the beginning of the
 headline.  Use `org-reduced-level' to remove the effect of
-`org-odd-levels'.  Unlike to `org-outline-level', this function
+`org-odd-levels-only'.  Unlike `org-outline-level', this function
 ignores inlinetasks."
   (let ((level (org-with-limited-levels (org-outline-level))))
     (and (> level 0) level)))
-- 
2.41.0

Re: [PATCH] org: fix symbol names and grammar in docstrings

[Ihor Radchenko]

gerard.vermeulen@posteo.net writes:

> The docstrings of `org-outline-level' and `org-current-level' contain
> the undefined symbol name `org-odd-levels'.
>
> The same lines of the docstrings contain also wording like
> "Unlike to `org-current-level'" and "Unlike to `org-outline-level'"
>   where "to" should not be there.
>
> This patch changes the symbol names to `org-odd-levels-only' and
> removes the "to" typos.

Thanks!
Applied, onto bugfix.
https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=a4586f0d7

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>