emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* [PATCH] document org-at-heading-p
@ 2018-11-01 15:14 Will Pierce
  2018-11-01 17:31 ` Nicolas Goaziou
  0 siblings, 1 reply; 2+ messages in thread
From: Will Pierce @ 2018-11-01 15:14 UTC (permalink / raw)
  To: emacs-orgmode


[-- 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


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH] document org-at-heading-p
  2018-11-01 15:14 [PATCH] document org-at-heading-p Will Pierce
@ 2018-11-01 17:31 ` Nicolas Goaziou
  0 siblings, 0 replies; 2+ messages in thread
From: Nicolas Goaziou @ 2018-11-01 17:31 UTC (permalink / raw)
  To: Will Pierce; +Cc: emacs-orgmode

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

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2018-11-01 17:31 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-11-01 15:14 [PATCH] document org-at-heading-p Will Pierce
2018-11-01 17:31 ` Nicolas Goaziou

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).