[elpa] externals/org bd7fab2129 1/2: lisp/org.el (org-in-src-block-p): Improve docstring

[ELPA Syncer]

branch: externals/org
commit bd7fab2129077d3fb84bc8bec7d7ecbc49afcc15
Author: Ihor Radchenko <yantar92@posteo.net>
Commit: Ihor Radchenko <yantar92@posteo.net>

    lisp/org.el (org-in-src-block-p): Improve docstring
    
    * lisp/org.el (org-in-src-block-p):
    
    Reported-by: No Wayman <iarchivedmywholelife@gmail.com>
    Link: https://orgmode.org/list/87il5n9owq.fsf@gmail.com
---
 lisp/org.el | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/lisp/org.el b/lisp/org.el
index d2cd0b9b77..19887ff1e7 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -18786,9 +18786,13 @@ With prefix arg UNCOMPILED, load the uncompiled 
versions."
   s)
 
 (defun org-in-src-block-p (&optional inside element)
-  "Whether point is in a code source block.
-When INSIDE is non-nil, don't consider we are within a source
-block when point is at #+BEGIN_SRC or #+END_SRC.
+  "Return t when point is at a source block element.
+When INSIDE is non-nil, return t only when point is between #+BEGIN_SRC
+and #+END_SRC lines.
+
+Note that affiliated keywords and blank lines after are considered a
+part of a source block.
+
 When ELEMENT is provided, it is considered to be element at point."
   (save-match-data (setq element (or element (org-element-at-point))))
   (when (org-element-type-p element 'src-block)