lisp/ox.el (org-export-table-row-number): Clarify docstring

This commit is contained in:
Ihor Radchenko 2024-04-02 15:49:01 +03:00
parent eceb2fac4c
commit d72feeb09b
No known key found for this signature in database
GPG Key ID: 6470762A7DA11D8B
1 changed files with 3 additions and 2 deletions

View File

@ -5417,10 +5417,11 @@ INFO is a plist used as a communication channel."
(org-export-table-row-ends-rowgroup-p table-row info))) (org-export-table-row-ends-rowgroup-p table-row info)))
(defun org-export-table-row-number (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 INFO is a plist used as a communication channel. Return value is
zero-indexed and ignores separators. The function returns nil 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) (when (eq (org-element-property :type table-row) 'standard)
(let* ((cache (or (plist-get info :table-row-number-cache) (let* ((cache (or (plist-get info :table-row-number-cache)
(let ((table (make-hash-table :test #'eq))) (let ((table (make-hash-table :test #'eq)))