Lerking/Phoenix
1
0
Fork 0
mirror of https://github.com/wxWidgets/Phoenix.git synced 2025-12-15 17:20:07 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

If a property's getter has a docstring, use it.

Browse Source
This commit is contained in:
Robin Dunn
2016-07-23 00:17:55 -07:00
parent 09d4d817e6
commit 9bcccff097
2 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
sphinxtools/librarydescription.py
View File

@@ -941,7 +941,7 @@ class Property(ChildrenBase):
def __init__(self, name, item):
ChildrenBase.__init__(self, name, object_types.PROPERTY)
self.getter = self.setter = self.deleter = ''
try:
@@ -972,19 +972,22 @@ class Property(ChildrenBase):
if self.is_redundant:
return
docs = ''
for item in [self.setter, self.getter, self.deleter]:
if item and 'lambda' not in item and not item.startswith('_'):
if docs:
docs += ', :meth:`~%s.%s` '%(class_name, item)
else:
docs += ':meth:`~%s.%s` '%(class_name, item)
docs = self.docs
if not docs:
for item in [self.setter, self.getter, self.deleter]:
if item and 'lambda' not in item and not item.startswith('_'):
if docs:
docs += ', :meth:`~%s.%s` ' % (class_name, item)
else:
docs += ':meth:`~%s.%s` ' % (class_name, item)
if docs:
docs = 'See %s' % docs
if docs:
docs = 'See %s'%docs
stream.write(' .. attribute:: %s\n\n'%self.GetShortName())
stream.write(' %s\n\n\n'%docs)
stream.write(' .. attribute:: %s\n\n' % self.GetShortName())
docs = '\n '.join(docs.splitlines())
stream.write(' %s\n\n\n' % docs)
class Attribute(ChildrenBase):

3
sphinxtools/modulehunter.py
View File

@@ -318,9 +318,6 @@ def describe_class(obj, module_class, module_name, constants):
if class_name == 'object':
return
if 'GenBitmapButton' in class_name:
print('GenBitmapButton')
class_name = module_class.name + '.' + class_name
docs = getdoc(obj)