Documenting Sagrada libs

Shane Caraveo mixedpuppy at gmail.com
Mon Sep 26 12:00:57 PDT 2011


On 11-09-26 11:05 AM, Gregory Szorc wrote:
> On 9/25/11 11:03 AM, Shane Caraveo wrote:
>> I'm partial to the google api docs that I mentioned a while back. I
>> haven't had time to work on the python version in a long time, but
>> here's what I wrote up about it.
>>
>> http://shane.caraveo.com/2011/06/30/using-json-schema-for-exploring-api-servers/
>>
>>
> I like the use of decorators in this approach. It's more readable to me
> than syntax within the documentation block. The real potential is when
> the server framework *and* the documentation both pull from the same
> source (decorators). Do any Python server frameworks do this?

The decorators build the doc string and insert it, so as long as another 
framework that uses the docstings loads the code so it runs the 
decorators, it might still work.

Shane


More information about the Services-dev mailing list