[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/ebdb cccdcea 3/4: Fix docs about potential value of ebd
From: |
Eric Abrahamsen |
Subject: |
[elpa] externals/ebdb cccdcea 3/4: Fix docs about potential value of ebdb-mua-default-formatter |
Date: |
Sat, 18 Jan 2020 14:32:53 -0500 (EST) |
branch: externals/ebdb
commit cccdcea635a814243e250c22f1ac4759645cbacf
Author: Eric Abrahamsen <address@hidden>
Commit: Eric Abrahamsen <address@hidden>
Fix docs about potential value of ebdb-mua-default-formatter
* ebdb-mua.el (ebdb-mua-default-formatter): It can't simply be an
instance of ebdb-formatter-ebdb, as that class is abstract. Got to be
oneline or multiline. Note in docstring.
* ebdb.org (Pop-up Buffers): Document in manual.
---
ebdb-mua.el | 7 +++--
ebdb.info | 92 +++++++++++++++++++++++++++++++------------------------------
ebdb.org | 9 +++---
ebdb.texi | 9 +++---
4 files changed, 61 insertions(+), 56 deletions(-)
diff --git a/ebdb-mua.el b/ebdb-mua.el
index 534f3ff..631f6ea 100644
--- a/ebdb-mua.el
+++ b/ebdb-mua.el
@@ -476,9 +476,10 @@ are not \"noticed\", nor is the timestamp updated."
(defcustom ebdb-mua-default-formatter ebdb-default-multiline-formatter
"The default formatter to use for MUA pop-up buffers.
-The value should be an instance of the `ebdb-formatter-ebdb'
-class. Easy choices are the value of
-`ebdb-default-multiline-formatter' or
+The value should be an instance of the
+`ebdb-formatter-ebdb-multiline' or the
+`ebdb-formatter-ebdb-oneline' classes. Easy choices are the
+value of `ebdb-default-multiline-formatter' or
`ebdb-default-oneline-formatter'."
:group 'ebdb-mua
:type 'ebdb-formatter-ebdb)
diff --git a/ebdb.info b/ebdb.info
index cba32f4..9fe7db7 100644
--- a/ebdb.info
+++ b/ebdb.info
@@ -662,10 +662,12 @@ command, or by cloning or renaming existing buffers.
-- User Option: ebdb-mua-default-formatter
The default formatter to use for MUA pop-up buffers. The value of
- this option should be an instance of ‘ebdb-formatter-ebdb’; it
- defaults to ‘ebdb-default-multiline-formatter’. Other likely
- options would be the value of ‘ebdb-default-oneline-formatter’, or
- a custom-made formatter, see *note Customizing Record Display::.
+ this option should be an instance of either the
+ ‘ebdb-formatter-ebdb-multiline’ or the
+ ‘ebdb-formatter-ebdb-oneline’ class; it defaults to
+ ‘ebdb-default-multiline-formatter’. Other likely options would be
+ the value of ‘ebdb-default-oneline-formatter’, or a custom-made
+ formatter, see *note Customizing Record Display::.
EBDB can also integrate with atomic windows (*Note (elisp)Atomic
Windows::).
@@ -2382,7 +2384,7 @@ File: ebdb.info, Node: Index, Prev: Hacking EBDB, Up:
Top
* ebdb-default-phone-class: Hacking EBDB. (line 40)
* ebdb-default-record-class: Creating Records. (line 10)
* ebdb-default-record-class <1>: Hacking EBDB. (line 24)
-* ebdb-default-window-size: Pop-up Buffers. (line 31)
+* ebdb-default-window-size: Pop-up Buffers. (line 33)
* ebdb-delete-field: Init and Delete Methods.
(line 15)
* ebdb-delete-field-or-record: The Basics of ebdb-mode.
@@ -2428,7 +2430,7 @@ File: ebdb.info, Node: Index, Prev: Hacking EBDB, Up:
Top
(line 6)
* ebdb-insert-field <1>: The Basics of ebdb-mode.
(line 30)
-* ebdb-join-atomic-windows: Pop-up Buffers. (line 26)
+* ebdb-join-atomic-windows: Pop-up Buffers. (line 28)
* ebdb-join-atomic-windows <1>: Customizing Record Display.
(line 24)
* ebdb-mail: The Basics of ebdb-mode.
@@ -2661,45 +2663,45 @@ Node: MUA Interaction20485
Node: Loading MUA Code21038
Node: Display and Updating21751
Node: Pop-up Buffers22517
-Node: Auto-Updating Records24437
-Node: Noticing and Automatic Rules28843
-Node: Interactive Commands30176
-Node: EBDB and MUA summary buffers32650
-Node: Sender name display33168
-Node: Summary buffer marks34395
-Node: Mail Address Completion35574
-Node: A Note on Completion38083
-Node: Specific MUAs38706
-Node: Gnus38854
-Node: Posting Styles39076
-Node: EBDB Buffers40651
-Node: Searching41862
-Node: Changing Search Behavior43576
-Node: The Basics of ebdb-mode44823
-Node: Customizing Record Display49171
-Node: Marking53491
-Node: Exporting/Formatting53918
-Node: Completion54853
-Node: Snarfing55649
-Node: Internationalization57666
-Node: Diary Integration60367
-Node: Mail Aliases61232
-Node: vCard Support61946
-Node: Org Integration62445
-Node: Citing Records64343
-Node: Hacking EBDB65101
-Node: Field Classes67694
-Node: Init and Delete Methods70830
-Node: The Labeled Field Class72337
-Node: The Singleton Field Class73191
-Node: Actions73629
-Node: Custom Field Searching74301
-Node: Fast Lookups77168
-Node: Formatting in the EBDB Buffer78978
-Node: Writing Internationalization Libraries81054
-Node: Writing Integration For New MUAs85470
-Node: Article snarfing88918
-Node: Index89636
+Node: Auto-Updating Records24515
+Node: Noticing and Automatic Rules28921
+Node: Interactive Commands30254
+Node: EBDB and MUA summary buffers32728
+Node: Sender name display33246
+Node: Summary buffer marks34473
+Node: Mail Address Completion35652
+Node: A Note on Completion38161
+Node: Specific MUAs38784
+Node: Gnus38932
+Node: Posting Styles39154
+Node: EBDB Buffers40729
+Node: Searching41940
+Node: Changing Search Behavior43654
+Node: The Basics of ebdb-mode44901
+Node: Customizing Record Display49249
+Node: Marking53569
+Node: Exporting/Formatting53996
+Node: Completion54931
+Node: Snarfing55727
+Node: Internationalization57744
+Node: Diary Integration60445
+Node: Mail Aliases61310
+Node: vCard Support62024
+Node: Org Integration62523
+Node: Citing Records64421
+Node: Hacking EBDB65179
+Node: Field Classes67772
+Node: Init and Delete Methods70908
+Node: The Labeled Field Class72415
+Node: The Singleton Field Class73269
+Node: Actions73707
+Node: Custom Field Searching74379
+Node: Fast Lookups77246
+Node: Formatting in the EBDB Buffer79056
+Node: Writing Internationalization Libraries81132
+Node: Writing Integration For New MUAs85548
+Node: Article snarfing88996
+Node: Index89714
End Tag Table
diff --git a/ebdb.org b/ebdb.org
index 1fca929..babb9e5 100644
--- a/ebdb.org
+++ b/ebdb.org
@@ -471,10 +471,11 @@ below).
#+ATTR_TEXINFO: :options ebdb-mua-default-formatter
#+begin_defopt
The default formatter to use for MUA pop-up buffers. The value of
-this option should be an instance of ~ebdb-formatter-ebdb~; it
-defaults to ~ebdb-default-multiline-formatter~. Other likely options
-would be the value of ~ebdb-default-oneline-formatter~, or a
-custom-made formatter, see
[[id:20fc7a2a-55a9-43ef-9534-9e5887682a88][Customizing Record Display]].
+this option should be an instance of either the
+~ebdb-formatter-ebdb-multiline~ or the ~ebdb-formatter-ebdb-oneline~
+class; it defaults to ~ebdb-default-multiline-formatter~. Other
+likely options would be the value of ~ebdb-default-oneline-formatter~,
+or a custom-made formatter, see
[[id:20fc7a2a-55a9-43ef-9534-9e5887682a88][Customizing Record Display]].
#+end_defopt
EBDB can also integrate with atomic windows (@@texinfo:@xref{Atomic
diff --git a/ebdb.texi b/ebdb.texi
index b713a54..a2bcc72 100644
--- a/ebdb.texi
+++ b/ebdb.texi
@@ -689,10 +689,11 @@ below).
@defopt ebdb-mua-default-formatter
The default formatter to use for MUA pop-up buffers. The value of
-this option should be an instance of @code{ebdb-formatter-ebdb}; it
-defaults to @code{ebdb-default-multiline-formatter}. Other likely options
-would be the value of @code{ebdb-default-oneline-formatter}, or a
-custom-made formatter, see @ref{Customizing Record Display}.
+this option should be an instance of either the
+@code{ebdb-formatter-ebdb-multiline} or the @code{ebdb-formatter-ebdb-oneline}
+class; it defaults to @code{ebdb-default-multiline-formatter}. Other
+likely options would be the value of @code{ebdb-default-oneline-formatter},
+or a custom-made formatter, see @ref{Customizing Record Display}.
@end defopt
EBDB can also integrate with atomic windows (@xref{Atomic