summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPatrick Totzke <patricktotzke@gmail.com>2012-03-11 18:31:30 +0000
committerPatrick Totzke <patricktotzke@gmail.com>2012-03-11 18:31:30 +0000
commit349654f4e62eb77754f08351bf3fb51fbe6d8f7c (patch)
treedc99f852d82cf7906b77543f6e6108e97531c015
parentcb46d4fa01109adac8c193e5523928261dc3e284 (diff)
docs: corrected pointers to db.message.Message
-rw-r--r--alot/buffers.py4
-rw-r--r--alot/commands/thread.py6
-rw-r--r--alot/db/thread.py12
-rw-r--r--alot/widgets.py6
4 files changed, 14 insertions, 14 deletions
diff --git a/alot/buffers.py b/alot/buffers.py
index 07f1af86..e4401198 100644
--- a/alot/buffers.py
+++ b/alot/buffers.py
@@ -291,7 +291,7 @@ class ThreadBuffer(Buffer):
return self.body.body.contents
def get_selected_message(self):
- """returns focussed :class:`~alot.message.Message`"""
+ """returns focussed :class:`~alot.db.message.Message`"""
messagewidget = self.get_selection()
return messagewidget.get_message()
@@ -308,7 +308,7 @@ class ThreadBuffer(Buffer):
def unfold_matching(self, querystring):
"""
unfolds those :class:`MessageWidgets <alot.widgets.MessageWidget>`
- that represent :class:`Messages <alot.message.Message>` matching
+ that represent :class:`Messages <alot.db.message.Message>` matching
`querystring`.
"""
for mw in self.get_message_widgets():
diff --git a/alot/commands/thread.py b/alot/commands/thread.py
index baf0bd1f..89a48fb4 100644
--- a/alot/commands/thread.py
+++ b/alot/commands/thread.py
@@ -75,7 +75,7 @@ class ReplyCommand(Command):
def __init__(self, message=None, all=False, spawn=None, **kwargs):
"""
:param message: message to reply to (defaults to selected message)
- :type message: `alot.message.Message`
+ :type message: `alot.db.message.Message`
:param all: group reply; copies recipients from Bcc/Cc/To to the reply
:type all: bool
:param spawn: force spawning of editor in a new terminal
@@ -177,7 +177,7 @@ class ForwardCommand(Command):
def __init__(self, message=None, attach=True, spawn=None, **kwargs):
"""
:param message: message to forward (defaults to selected message)
- :type message: `alot.message.Message`
+ :type message: `alot.db.message.Message`
:param attach: attach original mail instead of inline quoting its body
:type attach: bool
:param spawn: force spawning of editor in a new terminal
@@ -245,7 +245,7 @@ class EditNewCommand(Command):
def __init__(self, message=None, spawn=None, **kwargs):
"""
:param message: message to reply to (defaults to selected message)
- :type message: `alot.message.Message`
+ :type message: `alot.db.message.Message`
:param spawn: force spawning of editor in a new terminal
:type spawn: bool
"""
diff --git a/alot/db/thread.py b/alot/db/thread.py
index a13eac0e..e94e719e 100644
--- a/alot/db/thread.py
+++ b/alot/db/thread.py
@@ -9,7 +9,7 @@ class Thread(object):
A wrapper around a notmuch mailthread (:class:`notmuch.database.Thread`)
that ensures persistence of the thread: It can be safely read multiple
times, its manipulation is done via a :class:`alot.db.DBManager` and it
- can directly provide contained messages as :class:`~alot.message.Message`.
+ can directly provide contained messages as :class:`~alot.db.message.Message`.
"""
def __init__(self, dbman, thread):
@@ -185,7 +185,7 @@ class Thread(object):
This are all the messages without a parent message
(identified by 'in-reply-to' or 'references' header.
- :rtype: list of :class:`~alot.message.Message`
+ :rtype: list of :class:`~alot.db.message.Message`
"""
if not self._messages:
self.get_messages()
@@ -196,8 +196,8 @@ class Thread(object):
returns all messages in this thread as dict mapping all contained
messages to their direct responses.
- :rtype: dict mapping :class:`~alot.message.Message` to a list of
- :class:`~alot.message.Message`.
+ :rtype: dict mapping :class:`~alot.db.message.Message` to a list of
+ :class:`~alot.db.message.Message`.
"""
if not self._messages: # if not already cached
query = self._dbman.query('thread:' + self._id)
@@ -222,8 +222,8 @@ class Thread(object):
returns all replies to the given message contained in this thread.
:param msg: parent message to look up
- :type msg: :class:`~alot.message.Message`
- :returns: list of :class:`~alot.message.Message` or `None`
+ :type msg: :class:`~alot.db.message.Message`
+ :returns: list of :class:`~alot.db.message.Message` or `None`
"""
mid = msg.get_message_id()
msg_hash = self.get_messages()
diff --git a/alot/widgets.py b/alot/widgets.py
index eaf4c8e1..b07ae5f7 100644
--- a/alot/widgets.py
+++ b/alot/widgets.py
@@ -355,7 +355,7 @@ class CompleteEdit(urwid.Edit):
class MessageWidget(urwid.WidgetWrap):
"""
- Flow widget that renders a :class:`~alot.message.Message`.
+ Flow widget that renders a :class:`~alot.db.message.Message`.
Respected settings:
* `general.displayed_headers`
@@ -552,7 +552,7 @@ class MessageWidget(urwid.WidgetWrap):
return self.pile.keypress(size, key)
def get_message(self):
- """get contained :class`~alot.message.Message`"""
+ """get contained :class`~alot.db.message.Message`"""
return self.message
def get_email(self):
@@ -562,7 +562,7 @@ class MessageWidget(urwid.WidgetWrap):
class MessageSummaryWidget(urwid.WidgetWrap):
"""
- one line summary of a :class:`~alot.message.Message`.
+ one line summary of a :class:`~alot.db.message.Message`.
Theme settings:
* `thread_summary_even`