[Telepathy-commits] [telepathy-spec/master] Messages: clarify PendingMessages docs

Simon McVittie simon.mcvittie at collabora.co.uk
Fri Oct 31 09:01:28 PDT 2008


Calling this list a superset implies that it might have more messages,
which is false. It might have *more information*, though, so I'll say
"more detailed".

Also add <tp:dbus-ref> to replace clumsy wording with hyperlinks.

(As per review from wjt)
---
 spec/Channel_Interface_Messages.xml |   10 +++++++---
 1 files changed, 7 insertions(+), 3 deletions(-)

diff --git a/spec/Channel_Interface_Messages.xml b/spec/Channel_Interface_Messages.xml
index 7fefabb..c35841c 100644
--- a/spec/Channel_Interface_Messages.xml
+++ b/spec/Channel_Interface_Messages.xml
@@ -829,9 +829,13 @@ USA.</p>
       tp:type="Message_Part[][]" tp:name-for-bindings="Pending_Messages">
       <tp:docstring>
         A list of incoming messages that have neither been acknowledged nor
-        rejected. This list is a superset of the one returned by
-        ListPendingMessages on the Text interface; its items can be removed
-        using AcknowledgePendingMessages on that interface.
+        rejected. This list is a more detailed version of the one returned
+        by <tp:dbus-ref
+          namespace="org.freedesktop.Telepathy.Channel.Type">Text.ListPendingMessages</tp:dbus-ref>,
+        and contains the same messages, uniquely identified by the same
+        pending message IDs. Its items can be removed using
+        <tp:dbus-ref
+          namespace="org.freedesktop.Telepathy.Channel.Type">Text.AcknowledgePendingMessages</tp:dbus-ref>.
       </tp:docstring>
     </property>
 
-- 
1.5.6.5



More information about the Telepathy-commits mailing list