diff options
| author | Jonas Bernoulli <jonas@bernoul.li> | 2021-12-26 08:34:00 +0100 |
|---|---|---|
| committer | Jonas Bernoulli <jonas@bernoul.li> | 2021-12-26 08:38:04 +0100 |
| commit | 03f495f351d6e622143e4628681019df1313a5f2 (patch) | |
| tree | 20f5ea9eefd3284ec8c6639088f680d32a9fd700 /docs/magit-section.org | |
| parent | eb0d359dc57dd284852a723f442e149a3bb4832e (diff) | |
manual: Use updated support for definition commands
Instead of ox-texinfo+.el use the new implementation
that I expect to be merged into Org itself.
Diffstat (limited to 'docs/magit-section.org')
| -rw-r--r-- | docs/magit-section.org | 28 |
1 files changed, 13 insertions, 15 deletions
diff --git a/docs/magit-section.org b/docs/magit-section.org index 096c4d1..9a04fff 100644 --- a/docs/magit-section.org +++ b/docs/magit-section.org @@ -52,10 +52,9 @@ When the documentation leaves something unaddressed, then please consider that Magit uses this library extensively and search its source for suitable examples before asking me for help. Thanks! - * Creating Sections -- Macro: magit-insert-section [name] (type &optional value hide) &rest body +- Macro: magit-insert-section [name] (type &optional value hide) &rest body :: Create a section object of type CLASS, storing VALUE in its ~value~ slot, and insert the section at point. CLASS is a @@ -99,7 +98,7 @@ source for suitable examples before asking me for help. Thanks! a section by washing Git's output and Git didn't actually output anything this time around. -- Function: magit-insert-heading &rest args +- Function: magit-insert-heading &rest args :: Insert the heading for the section currently being inserted. @@ -128,19 +127,19 @@ source for suitable examples before asking me for help. Thanks! getting it right. The only exception is that this function does insert a newline character if necessary. -- Macro: magit-insert-section-body &rest body +- Macro: magit-insert-section-body &rest body :: Use BODY to insert the section body, once the section is expanded. If the section is expanded when it is created, then this is like ~progn~. Otherwise BODY isn't evaluated until the section is explicitly expanded. -- Function: magit-cancel-section +- Function: magit-cancel-section :: Cancel inserting the section that is currently being inserted. Remove all traces of that section. -- Function: magit-wash-sequence function +- Function: magit-wash-sequence function :: Repeatedly call FUNCTION until it returns ~nil~ or the end of the buffer is reached. FUNCTION has to move point forward or return @@ -148,16 +147,16 @@ source for suitable examples before asking me for help. Thanks! * Core Functions -- Function: magit-current-section +- Function: magit-current-section :: Return the section at point. -- Function: magit-section-ident section +- Function: magit-section-ident section :: Return an unique identifier for SECTION. The return value has the form ~((TYPE . VALUE)...)~. -- Function: magit-section-ident-value value +- Function: magit-section-ident-value value :: Return a constant representation of VALUE. @@ -169,21 +168,21 @@ source for suitable examples before asking me for help. Thanks! catch-all method is used, which just returns the argument itself. -- Function: magit-get-section ident &optional root +- Function: magit-get-section ident &optional root :: Return the section identified by IDENT. IDENT has to be a list as returned by ~magit-section-ident~. If optional ROOT is non-nil, then search in that section tree instead of in the one whose root ~magit-root-section~ is. -- Function: magit-section-lineage section +- Function: magit-section-lineage section :: Return the lineage of SECTION. The return value has the form ~(TYPE...)~. * Matching Functions -- Function: magit-section-match condition &optional (section (magit-current-section)) +- Function: magit-section-match condition &optional (section (magit-current-section)) :: Return t if SECTION matches CONDITION. @@ -217,7 +216,7 @@ source for suitable examples before asking me for help. Thanks! lineage as printed by ~magit-describe-section-briefly~, unless of course you want to be that precise. -- Function: magit-section-value-if condition &optional section +- Function: magit-section-value-if condition &optional section :: If the section at point matches CONDITION, then return its value. @@ -228,7 +227,7 @@ source for suitable examples before asking me for help. Thanks! See ~magit-section-match~ for the forms CONDITION can take. -- Macro: magit-section-case &rest clauses +- Macro: magit-section-case &rest clauses :: Choose among clauses on the type of the section at point. @@ -272,7 +271,6 @@ General Public License for more details. # Local Variables: # eval: (require 'magit-utils nil t) # eval: (require 'ol-man nil t) -# eval: (require 'ox-texinfo+ nil t) # indent-tabs-mode: nil # org-src-preserve-indentation: nil # End: |
