Improve telepathy docs

[davelab6]

https://www.sam.today/blog/telepathy-10-lists.html lists some issues with the way telepathy was used in activities; this suggests we can improve our docs with telepathy guidance :)

[Aniket21mathur]

I think now we need "How to use TelepathyGLib" docs instead.

[quozl]

We used to leave that to the Telepathy project, and we did have people who contributed to both Sugar and Telepathy. Telepathy contains some features specific to Sugar. But the Telepathy project has slowed down; the number of commits to Telepathy is below one per year. Documentation is available from Telepathy project, but it isn't up to the standards we are used to with other libraries. Best would be to clone the Telepathy sources and review the documentation and source code. That will inform your use of TelepathyGLib.

[Aniket21mathur]

Now we have switched to TelepathyGLib, using dbus calls instead of telepathy calls, so our documentation may include -

• How to make a dictionary of interfaces using dbus.
• Using constants from TelepathyGLib. Need suggestions!

@quozl can this issue be related to https://github.com/sugarlabs/sugar-toolkit-gtk3/issues/417?

[quozl]

Now we have switched to TelepathyGLib, using dbus calls instead of telepathy calls, so our documentation may include -

* How to make a dictionary of interfaces using dbus.

You have demonstrated how to do that. You might add it to the Port to Python 3 page? https://github.com/sugarlabs/sugar-docs/blob/master/src/python-porting-guide.md

* Using constants from TelepathyGLib.

Same.

  Need suggestions!

@quozl can this issue be related to sugarlabs/sugar-toolkit-gtk3#417?

No. The issue there is with the automatically generated documentation which comes from the docstrings in the source. The source hasn't got any significant inline documentation, especially when compared with the Activity class which has a lot.

I think these are two separate issues; porting documentation, and API documentation.

[Aniket21mathur]

Thanks. Agreed!