Add doc for account, display_account and account_base variables

ledger · Aug 7, 2024 · 7718901 · 7718901
1 parent 4cbd4eb
commit 7718901
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/doc/ledger3.texi b/doc/ledger3.texi
@@ -8510,6 +8510,19 @@ Assets:Cash ¤ 123,45
 @end smallexample
 @end defun
 
+@defvar account
+@defvarx a
+@defvarx A
+Return the concerned account.
+
+It may be appended with @code{.note} or @code{.depth} to get either the note
+or the depth of the account
+@end defvar
+
+@defvar account_base
+Return the last part of the account hierarchy.
+@end defvar
+
 @defun amount_expr
 Return the calculated amount of the posting according to the @option{--amount}
 option.
@@ -8573,6 +8586,14 @@ $ ledger -f expr.dat --format "%(date) %(account)\n" reg assets
 2015/01/16 Assets:Cash
 @end smallexample
 
+@defvar display_account
+Return the concerned account, surrounded with @code{[]} or @code{()} for
+virtual postings.
+
+It may be appended with @code{.note} or @code{.depth} to get either the note
+or the depth of the account
+@end defvar
+
 @defvar display_amount
 @defvarx t
 @value{FIXME:UNDOCUMENTED}