Bug 18219

Summary: RequestConnection's well-known key list and argument documentation is unclear
Product: Telepathy Reporter: Will Thompson <will>
Component: tp-specAssignee: Telepathy bugs list <telepathy-bugs>
Status: RESOLVED FIXED QA Contact: Telepathy bugs list <telepathy-bugs>
Severity: normal    
Priority: medium CC: murrayc
Version: unspecified   
Hardware: Other   
OS: All   
Whiteboard:
i915 platform: i915 features:

Description Will Thompson 2008-10-25 03:07:11 UTC 
RequestConnection's list of well-known connection parameters[0] lists a string key named "foo" as "s:foo", which does not make it clear that "s:" is not part of the key. It would be better if they looked more like the documentation of MessageParts' keys[1].

The Parameters parameter (!) being described as "A dictionary mapping parameter name to the variant boxed value" is also kind of cryptic.

[0] http://telepathy.freedesktop.org/spec.html#org.freedesktop.Telepathy.ConnectionManager
[1] http://telepathy.freedesktop.org/spec.html#org.freedesktop.Telepathy.Channel.Interface.Messages.DRAFT.Message_Part
Comment 1 Will Thompson 2008-11-21 12:07:19 UTC 
Fixed in a trivia branch which I anticipate being merged imminently.

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.