status-im/PyGithub
1
0
Fork 0
mirror of https://github.com/status-im/PyGithub.git synced 2026-08-31 19:01:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve generated docstrings (slightly)

Browse Source
This commit is contained in:
Vincent Jacques
2012-09-17 19:01:24 +02:00
parent dc96905c05
commit e3bbacef21
2 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/ReferenceOfClasses.md
+2
View File
@@ -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`
generateDocstrings.py
+3 -1
View File
@@ -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" ),
"",
] + [