magit-insert-heading: Add optional CHILD-COUNT argument

1 files changed, 8 insertions, 1 deletions

diff --git a/docs/magit-section.texi b/docs/magit-section.texi
index b59635b..bf59f33 100644
--- a/docs/magit-section.texi
+++ b/docs/magit-section.texi
@@ -129,7 +129,7 @@ a section by washing Git's output and Git didn't actually output
 anything this time around.
 @end defmac
 
-@defun magit-insert-heading &rest args
+@defun magit-insert-heading [child-count] &rest args
 Insert the heading for the section currently being inserted.
 
 This function should only be used inside @code{magit-insert-section}.
@@ -156,6 +156,13 @@ then its height must be exactly one line, including a trailing
 newline character.  This isn't enforced, you are responsible for
 getting it right.  The only exception is that this function does
 insert a newline character if necessary.
+
+If provided, optional CHILD-COUNT must evaluate to an integer or
+boolean.  If t, then the count is determined once the children have been
+inserted, using @code{magit-insert-child-count} (which see).  For historic
+reasons, if the heading ends with ":", the count is substituted for
+that, at this time as well.  If @code{magit-section-show-child-count} is nil,
+no counts are inserted
 @end defun
 
 @defmac magit-insert-section-body &rest body