branch: externals/org
commit d72feeb09bea8e940c1a4d57aacc94c12c84a34f
Author: Ihor Radchenko <yanta...@posteo.net>
Commit: Ihor Radchenko <yanta...@posteo.net>
lisp/ox.el (org-export-table-row-number): Clarify docstring
---
lisp/ox.el | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/lisp/ox.el b/lisp/ox.el
index 9ca19db43c..caac4c9aa2 100644
--- a/lisp/ox.el
+++ b/lisp/ox.el
@@ -5417,10 +5417,11 @@ INFO is a plist used as a communication channel."
(org-export-table-row-ends-rowgroup-p table-row info)))
(defun org-export-table-row-number (table-row info)
- "Return TABLE-ROW number.
+ "Return TABLE-ROW number in the exported table.
INFO is a plist used as a communication channel. Return value is
zero-indexed and ignores separators. The function returns nil
-for special rows and separators."
+when TABLE-ROW is a separator or when it is listed in :ignore-list
+property of the INFO plist."
(when (eq (org-element-property :type table-row) 'standard)
(let* ((cache (or (plist-get info :table-row-number-cache)
(let ((table (make-hash-table :test #'eq)))
