From e3bbacef211c976e2edcc4015c8ee2f1b4b143a1 Mon Sep 17 00:00:00 2001 From: Vincent Jacques Date: Mon, 17 Sep 2012 19:01:24 +0200 Subject: [PATCH] Improve generated docstrings (slightly) --- doc/ReferenceOfClasses.md | 2 ++ generateDocstrings.py | 4 +++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/ReferenceOfClasses.md b/doc/ReferenceOfClasses.md index 19e745a4..53ed30a1 100644 --- a/doc/ReferenceOfClasses.md +++ b/doc/ReferenceOfClasses.md @@ -21,7 +21,9 @@ Methods ------- * `get_user()`: `AuthenticatedUser` * `get_user( login )`: `NamedUser` + * `login`: string * `get_organization( login )`: `Organization` + * `login`: string * `get_gist( id )`: `Gist` * `id`: string * `get_gists()`: `PaginatedList` of `Gist` diff --git a/generateDocstrings.py b/generateDocstrings.py index 3dc52d51..338b3733 100644 --- a/generateDocstrings.py +++ b/generateDocstrings.py @@ -43,11 +43,13 @@ class Generator(): if memberName in classDescription.properties: return [ "Please edit this generated docstring for property " + className + "." + memberName + ".", - classDescription.properties[ memberName ] + "", + ":type: " + classDescription.properties[ memberName ] ] elif memberName in classDescription.methods: return [ "Please edit this generated docstring for method " + className + "." + memberName + ".", + "", "Calls " + ( classDescription.methods[ memberName ].verb or "WTF" ) + " " + ( classDescription.methods[ memberName ].url or "WTF" ), "", ] + [