[PATCH] document org-at-heading-p

[PATCH] document org-at-heading-p

[Will Pierce]

[-- Attachment #1.1: Type: text/plain, Size: 53 bytes --]

* add brief docstring pointing to outline-on-heading

[-- Attachment #1.2: Type: text/html, Size: 99 bytes --]

[-- Attachment #2: 0001-document-org-at-heading-p.patch --]
[-- Type: application/octet-stream, Size: 797 bytes --]

From 41796f33d083367bf99303cb8d33f289472825b5 Mon Sep 17 00:00:00 2001
From: pierwill <19642016+pierwill@users.noreply.github.com>
Date: Thu, 1 Nov 2018 10:08:35 -0500
Subject: [PATCH] document org-at-heading-p

* add brief docstring pointing to outline-on-heading
---
 lisp/org.el | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/lisp/org.el b/lisp/org.el
index c0eaecdab..52b817ef0 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -22978,6 +22978,9 @@ interactive command with similar behavior."
      (null (re-search-backward org-outline-regexp-bol nil t)))))
 
 (defun org-at-heading-p (&optional ignored)
+  "Return t if point is on a heading line.
+
+Calls `outline-on-heading-p'."
   (outline-on-heading-p t))
 
 (defun org-in-commented-heading-p (&optional no-inheritance)
-- 
2.19.1

Re: [PATCH] document org-at-heading-p

[Nicolas Goaziou]

Hello,

Will Pierce <pierwill@gmail.com> writes:

> * add brief docstring pointing to outline-on-heading
> From 41796f33d083367bf99303cb8d33f289472825b5 Mon Sep 17 00:00:00 2001
> From: pierwill <19642016+pierwill@users.noreply.github.com>
> Date: Thu, 1 Nov 2018 10:08:35 -0500
> Subject: [PATCH] document org-at-heading-p

I added the missing docstring.

> * add brief docstring pointing to outline-on-heading

I disagree with this.  This is an implementation detail.

Thank you!

Regards,

-- 
Nicolas Goaziou