Skip to content

Commit 11abc67

Browse files
committed
DOC: use napoleon format in _linkAtomAttribute
1 parent fd523d1 commit 11abc67

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

src/diffpy/structure/utils.py

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,19 @@ def atomBareSymbol(smbl):
4444

4545
def _linkAtomAttribute(attrname, doc, toarray=numpy.array):
4646
'''Create property wrapper that maps the specified atom attribute.
47+
4748
The returned property object provides convenient access to atom
4849
attributes from the owner Structure class.
4950
50-
attrname -- string name of the Atom class attribute to be mapped
51-
doc -- docstring of the property wrapper
52-
toarray -- factory function that converts list of attributes to
53-
numpy.array. Use numpy.char.array for string attributes.
51+
Parameters
52+
----------
53+
attrname : str
54+
The string name of the Atom class attribute to be mapped.
55+
doc : str
56+
The docstring for the property wrapper.
57+
toarray : callable, optional
58+
Factory function that converts list of attributes to `numpy.ndarray`.
59+
Use `numpy.char.array` for string attributes.
5460
5561
Return a property object.
5662
'''

0 commit comments

Comments
 (0)