Skip to content

Commit e392485

Browse files
committed
skpkg: doc formatting autofixes
1 parent 412bbf5 commit e392485

32 files changed

+127
-82
lines changed

doc/source/examples/distanceprinter.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
#!/usr/bin/env python
22

3-
"""Demonstration of using PairQuantity class for a printout of pair distances
4-
in periodic and non-periodic structures."""
3+
"""Demonstration of using PairQuantity class for a printout of pair
4+
distances in periodic and non-periodic structures."""
55

66
from diffpy.srreal.pairquantity import PairQuantity
77
from diffpy.structure import Structure
88

99

1010
class DistancePrinter(PairQuantity):
11-
"""This PairQuantity class simply prints the visited pair distances and the
12-
indices of the contributing atoms."""
11+
"""This PairQuantity class simply prints the visited pair distances
12+
and the indices of the contributing atoms."""
1313

1414
def _resetValue(self):
1515
self.count = 0

doc/source/examples/lennardjones/ljcalculator.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env python
22

3-
"""Demonstration of using PairQuantity class for calculation of Lennard Jones
4-
potential.
3+
"""Demonstration of using PairQuantity class for calculation of Lennard
4+
Jones potential.
55
66
Vij = 4 * ( rij ** -12 - rij ** -6 )
77
"""

doc/source/examples/parallelPDF.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
#!/usr/bin/env python
22

3-
"""Demonstration of parallel PDF calculation using the multiprocessing package.
3+
"""Demonstration of parallel PDF calculation using the multiprocessing
4+
package.
45
56
A PDF of menthol structure is first calculated on a single core and then
67
on all computer CPUs. The script then compares both results and prints

src/diffpy/srreal/_docstrings.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818

1919

2020
def get_registry_docstrings(cls):
21-
"""Build a dictionary of docstrings per each HasClassRegistry method.
21+
"""Build a dictionary of docstrings per each HasClassRegistry
22+
method.
2223
2324
Parameters
2425
----------

src/diffpy/srreal/_final_imports.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@
2525

2626

2727
def import_now():
28-
"""Import all Python modules that tweak extension-defined classes."""
28+
"""Import all Python modules that tweak extension-defined
29+
classes."""
2930
global _import_now_called
3031
if _import_now_called:
3132
return

src/diffpy/srreal/atomradiitable.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,9 @@ def clone(self):
6363
return copy.copy(self)
6464

6565
def type(self):
66-
"""Unique string identifier of the CovalentRadiiTable type. This is
67-
used for class registration and as an argument for the createByType
68-
function.
66+
"""Unique string identifier of the CovalentRadiiTable type. This
67+
is used for class registration and as an argument for the
68+
createByType function.
6969
7070
Return string.
7171
"""

src/diffpy/srreal/attributes.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ def _getattr(self, name):
3636

3737

3838
def _setattr(self, name, value):
39-
"""Assign to C++ double attribute if Python attribute does not exist."""
39+
"""Assign to C++ double attribute if Python attribute does not
40+
exist."""
4041
try:
4142
object.__getattribute__(self, name)
4243
except AttributeError:

src/diffpy/srreal/bondcalculator.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@
4343

4444

4545
def _init_kwargs(self, **kwargs):
46-
"""Create a new instance of BondCalculator. Keyword arguments can be used
47-
to configure calculator properties, for example:
46+
"""Create a new instance of BondCalculator. Keyword arguments can be
47+
used to configure calculator properties, for example:
4848
4949
bdc = BondCalculator(rmin=1.5, rmax=2.5)
5050

src/diffpy/srreal/devutils/tunePeakPrecision.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env python
22

3-
"""Tune the peak precision parameter so that PDFCalculator gives equivalent
4-
results to diffpy.pdffit2.
3+
"""Tune the peak precision parameter so that PDFCalculator gives
4+
equivalent results to diffpy.pdffit2.
55
66
Usage: tunePeakPrecision.py [qmax] [peakprecision] [createplot]
77
"""

src/diffpy/srreal/eventticker.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
# See LICENSE.txt for license information.
1313
#
1414
##############################################################################
15-
"""Class EventTicker -- storage of modification times of dependent objects."""
15+
"""Class EventTicker -- storage of modification times of dependent
16+
objects."""
1617

1718

1819
# exported items

0 commit comments

Comments
 (0)