From 9bcccff097e91160d878e69a12f6c3165877aa73 Mon Sep 17 00:00:00 2001 From: Robin Dunn Date: Sat, 23 Jul 2016 00:17:55 -0700 Subject: [PATCH] If a property's getter has a docstring, use it. --- sphinxtools/librarydescription.py | 29 ++++++++++++++++------------- sphinxtools/modulehunter.py | 3 --- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/sphinxtools/librarydescription.py b/sphinxtools/librarydescription.py index 5c4828a8..27271a55 100644 --- a/sphinxtools/librarydescription.py +++ b/sphinxtools/librarydescription.py @@ -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): diff --git a/sphinxtools/modulehunter.py b/sphinxtools/modulehunter.py index f484ec1f..7fbd5a55 100644 --- a/sphinxtools/modulehunter.py +++ b/sphinxtools/modulehunter.py @@ -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)