Summary: | Document client-interests parsably | ||
---|---|---|---|
Product: | Telepathy | Reporter: | Danielle Madeley <danielle> |
Component: | tp-spec | Assignee: | Danielle Madeley <danielle> |
Status: | RESOLVED FIXED | QA Contact: | Telepathy bugs list <telepathy-bugs> |
Severity: | normal | ||
Priority: | medium | Keywords: | patch |
Version: | git master | ||
Hardware: | Other | ||
OS: | All | ||
URL: | http://git.collabora.co.uk/?p=user/danni/telepathy-spec.git;a=shortlog;h=refs/heads/client-interests | ||
Whiteboard: | review+ | ||
i915 platform: | i915 features: |
Description
Danielle Madeley
2010-11-29 21:09:47 UTC
http://git.collabora.co.uk/?p=user/danni/telepathy-spec.git;a=shortlog;h=refs/heads/client-interests Patch to implement. Having client interests be machine-readable is good, but I'd like a test in test/test-specparser.py or something. (Does `make check` still pass, btw? I recently reinstated test-specparser, which wasn't run by `make check` and so hadn't worked for several releases.) The syntax I had in mind was that client interests would either look like interface names (o.fd.T.C.I.MailNotification) or like contact attributes and other tokens (hypothetically, o.fd.T.C.I.MailNotification/count). Perhaps rather than having name="" be magical (which makes the short_name be the empty string, which seems rather astonishing), it'd be better to have different markup for the two cases, something like this? <interface name="o.fd.T.C.I.MailNotification"> <tp:is-client-interest> Clients MUST blah blah unless they enable <tp:token-ref>count</> instead </tp:is-client-interest> <tp:client-interest name="count"> Clients MAY blah blah without adding the interface name as an interest </tp:client-interest> I wondered if they were meant to be tokens like contact attributes. I should have read the rationales (which are the only place where this is explicit). I personally don't like <tp:is-client-interest> (we don't have anything like this elsewhere). I would rather have a <tp:client-interest> where you omit the name attribute. Whatever we have, short_name is still going to be empty. Updated to include tests. Also added a new method for building the anchors (<a name="for-example">), Base.get_anchor(), and have changed both get_url() and the templates to use this method. This removes the duplicate building of the anchors, and makes it easier to change how anchors are constructed. Have then changed the anchors to include the item type, to prevent future potential namespace conflicts between things like client-interests and other tokens (idk it could happen). Also makes the URLs that little bit shorter, and includes the type in the URL (which is nice). Example: http://people.freedesktop.org/~danni/telepathy-spec-client_interests/spec/Connection_Interface_Mail_Notification.html r+, thanks Merged. |
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.