Code review comment for lp:~elementary-apps/granite/document-contract-interface

Revision history for this message
Victor Martinez (victored) wrote :

Great work!

The description for the Contract interface isn't very accurate. As the API is quite self-describing, it'd be better to keep it simple. For example:

"Interface for accessing contract actions and properties." instead of "Opaque object representing a Contractor action".
We could simply avoid "Returned by" as it's rarely used in Vala documentation and you'd have to list every method of ContractorProxy returning such objects.

That said, you've done a great job documenting the methods of the Contract interface and you're also providing proper guidance on handling ContractorError.SERVICE_NOT_AVAILABLE.

review: Needs Fixing

« Back to merge proposal