status-im/PyGithub
1
0
Fork 0
mirror of https://github.com/status-im/PyGithub.git synced 2026-09-01 11:21:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation generation

Browse Source
This commit is contained in:
Vincent Jacques
2012-02-26 15:41:34 +00:00
parent 37a62f4c6f
commit a6d6f05e75
8 changed files with 468 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files
github/ObjectCapacities/Basic.py
+7 -2
View File
@@ -28,10 +28,11 @@ class AttributeFromCallable:
### @todo include the ArgumentsChecker
class MethodFromCallable:
def __init__( self, name, mandatoryParameters, optionalParameters, callable ):
def __init__( self, name, mandatoryParameters, optionalParameters, callable, returnTypePolicy ):
self.__argumentsChecker = ArgumentsChecker( mandatoryParameters, optionalParameters )
self.__name = name
self.__callable = callable
self.__returnTypePolicy = returnTypePolicy
def apply( self, cls ):
cls._addMethod( self.__name, self.__execute )
@@ -41,7 +42,11 @@ class MethodFromCallable:
return self.__callable( obj, **data )
def autoDocument( self ):
return "* `" + self.__name + "(" + self.__argumentsChecker.documentParameters() + ")`\n"
doc = "* `" + self.__name + "(" + self.__argumentsChecker.documentParameters() + ")`"
if self.__returnTypePolicy.hasMeaningfulDocumentation():
doc += ": " + self.__returnTypePolicy.documentTypeName()
doc += "\n"
return doc
class InternalAttribute:
class AttributeDefinition: