IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

[Napoleon] Updates docs to use single quoted strings & 4-space indentation

Browse Source
This commit is contained in:
Rob Ruana 2015-06-11 20:21:37 -07:00
parent 92bf7ca36a
commit d5d6556a8a
1 changed files with 58 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/ext/example_google.py
View File

@ -194,7 +194,7 @@ class ExampleClass(object):
self.attr3 = param3 #: Doc comment *inline* with attribute self.attr3 = param3 #: Doc comment *inline* with attribute
#: List[str]: Doc comment *before* attribute, with type specified #: List[str]: Doc comment *before* attribute, with type specified
self.attr4 = ["attr4"] self.attr4 = ['attr4']
self.attr5 = None self.attr5 = None
"""Optional[str]: Docstring *after* attribute, with type specified""" """Optional[str]: Docstring *after* attribute, with type specified"""
@ -202,7 +202,7 @@ class ExampleClass(object):
@property @property
def readonly_property(self): def readonly_property(self):
"""str: Properties should be documented in their getter method""" """str: Properties should be documented in their getter method"""
return "readonly_property" return 'readonly_property'
@property @property
def readwrite_property(self): def readwrite_property(self):
@ -212,7 +212,7 @@ class ExampleClass(object):
If the setter method contains notable behavior, it should be If the setter method contains notable behavior, it should be
mentioned here. mentioned here.
""" """
return ["readwrite_property"] return ['readwrite_property']
@readwrite_property.setter @readwrite_property.setter
def readwrite_property(self, value): def readwrite_property(self, value):