[Bug 31160] New: Sparse documentation for Call.Stream

[bugzilla-daemon at freedesktop.org]

https://bugs.freedesktop.org/show_bug.cgi?id=31160

           Summary: Sparse documentation for Call.Stream
           Product: Telepathy
           Version: git master
          Platform: Other
        OS/Version: All
            Status: NEW
          Severity: normal
          Priority: medium
         Component: tp-spec
        AssignedTo: telepathy-bugs at lists.freedesktop.org
        ReportedBy: jonathon at quotidian.org
         QAContact: telepathy-bugs at lists.freedesktop.org


Currently, the only class-level documentation for the Call.Stream class is:

"One stream inside a Content.DRAFT."

This doesn't really provide a very nice conceptual overview of what a stream
class is supposed to be.  
In addition, the documentation for the "Streams" property on the Content class
doesn't shed a lot more light on things.  

The class-level documentation for Call.Content does have a *little* more
information about streams ("Each content has one or more Stream.DRAFT objects
which represent the actual transport to one or more remote contacts.").  At the
very least, this description should be copied into the documentation for the
Stream class itself.  But it would be nice if it was expanded a bit more as
well.

-- 
Configure bugmail: https://bugs.freedesktop.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the QA contact for the bug.
You are the assignee for the bug.