Skip to content

Commit

Permalink
magit-insert-section: Update doc-string
Browse files Browse the repository at this point in the history
  • Loading branch information
tarsius committed Jan 23, 2020
1 parent 2c36bc8 commit cbec7db
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions lisp/magit-section.el
Original file line number Diff line number Diff line change
Expand Up @@ -1028,13 +1028,11 @@ what you are doing and are sure there is no other way.")
(defmacro magit-insert-section (&rest args)
"Insert a section at point.
TYPE is the section type, a symbol. Many commands that act on
the current section behave differently depending on that type.
Also if a variable `magit-TYPE-section-map' exists, then use
that as the text-property `keymap' of all text belonging to the
section (but this may be overwritten in subsections). TYPE can
also have the form `(eval FORM)' in which case FORM is evaluated
at runtime.
TYPE is the section type, a symbol which is prefixed with the
name of the package. (For historic reasons the types used by
Magit and Forge do not use a package prefix.) Many commands
that act on the current section behave differently depending
on its type.
Optional VALUE is the value of the section, usually a string
that is required when acting on the section.
Expand All @@ -1049,7 +1047,7 @@ still honored).
BODY is any number of forms that actually insert the section's
heading and body. Optional NAME, if specified, has to be a
symbol, which is then bound to the struct of the section being
symbol, which is then bound to the object of the section being
inserted.
Before BODY is evaluated the `start' of the section object is set
Expand All @@ -1063,6 +1061,12 @@ of the partially inserted section. This can happen when creating
a section by washing Git's output and Git didn't actually output
anything this time around.
For historic reasons, if a variable `magit-TYPE-section-map'
or `forge-TYPE-section-map' exists, then use that as the
text-property `keymap' of all text belonging to the section (but
this may be overwritten in subsections). TYPE can also have the
form `(eval FORM)' in which case FORM is evaluated at runtime.
\(fn [NAME] (TYPE &optional VALUE HIDE) &rest BODY)"
(declare (indent defun)
(debug ([&optional symbolp]
Expand Down

0 comments on commit cbec7db

Please sign in to comment.