Skip to content

Commit 0aea01b

Browse files
author
Uli Köhler
committed
Fix pydocstyle documentation issues
- Fix D213: Multi-line docstring summary should start at the second line - Fix D413: Missing blank line after last section - Fix D212: Multi-line docstring summary should start at the first line - Fix D415: First line should end with a period - Fix D204: 1 blank line required after class docstring - Fix D203: 1 blank line required before class docstring - Fix D409/D405: Section name capitalization and underline length
1 parent e85f3ed commit 0aea01b

13 files changed

Lines changed: 20 additions & 16 deletions

File tree

UliEngineering/Chemistry/DNARNA.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,9 @@ class DNANucleotideWeights:
5050

5151
@dataclass
5252
class RNANucleotideWeights:
53-
"""
54-
MolThis includes the backbone phosphate group.
53+
"""Molecular weights of the four RNA nucleotides in g/mol.
54+
55+
This includes the backbone phosphate group.
5556
5657
Source: https://www.thermofisher.com/de/de/home/references/ambion-tech-support/rna-tools-and-calculators/dna-and-rna-molecular-weights-and-conversions.html
5758
"""

UliEngineering/Chemistry/Kohlrausch.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
#!/usr/bin/env python3
22
# -*- coding: utf-8 -*-
3-
"""Kohlrausch's law of independent migration of ions.
3+
"""
4+
Kohlrausch's law of independent migration of ions.
45
56
Kohlrausch's law states that the limiting molar conductivity of an electrolyte
67
is the sum of the individual contributions of the cation and anion:

UliEngineering/Electronics/OpAmp.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
#!/usr/bin/env python3
22
# -*- coding: utf-8 -*-
3-
"""
4-
Utilities for operational amplifier calculations.
3+
"""Utilities for operational amplifier calculations.
54
65
Usage example:
76
>>> from UliEngineering.Electronics.OpAmp import summing_amplifier_noninv

UliEngineering/Electronics/PowerFactor.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ def power_factor_by_phase_angle(angle: NormalizableArgument = "10°", unit: str
1717
This approach only returns the correct power factor if current and voltage
1818
are both sinusoidal.
1919
20-
Keyword arguments:
21-
------------------
20+
Keyword Arguments
21+
----------------
2222
angle : number or Engineer string
2323
The phase angle between current and voltage.
2424
unit : "degrees", "deg" or "radians", "rad", "radiant"

UliEngineering/Electronics/SwitchingRegulator.py

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

2222
@returns_unit("H")
2323
def buck_regulator_inductance(vin: VoltageV, vout: VoltageV, frequency: FrequencyHz, ioutmax: CurrentA, K=0.3):
24-
"""Compute the optimal inductance for use in a buck regulator.
24+
"""
25+
Compute the optimal inductance for use in a buck regulator.
2526
2627
This formula is based on the the inductor ripple current fraction [K].
2728

UliEngineering/Math/Coordinates.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88

99

1010
class BoundingBox(object):
11-
"""
12-
A 2D bounding box.
11+
"""A 2D bounding box.
1312
"""
1413

1514
def __init__(self, points):

UliEngineering/Mechanics/Threads.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ class ThreadParameters(namedtuple("ThreadParameters", ["pitch", "outer_diameter"
1515
Outside thread diameter in mm (for exterior thread)
1616
inner_diameter:
1717
Inside thread diameter in mm (for exterior thread)
18+
1819
"""
1920

2021
threads = {

UliEngineering/Physics/NoiseDensity.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ def noise_density(actual_noise: VoltageVolt, bandwith: FrequencyHz):
3636
"""
3737
Compute the noise density given:
3838
- A noise density in x/√Hz where x is any unit
39-
- A bandwith in ΔHz
39+
- A bandwith in ΔHz.
4040
4141
>>> formatValue(noiseDensity("1.0 mV", "100 Hz"), "V/√Hz")
4242

UliEngineering/SignalProcessing/WrappedValues.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ class OnlineUnwrapper:
1414
1515
Maintains state between calls.
1616
"""
17+
1718
def __init__(self, wrap_value=2**20, threshold=None):
1819
"""
1920
Initialize the unwrapper.

UliEngineering/Units.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,7 @@
2020
g = Unit("g")
2121

2222
class UnannotatedReturnValueError(Exception):
23-
"""
24-
Raise if the automatic unit finder cannot find the appropriate function.
23+
"""Raise if the automatic unit finder cannot find the appropriate function.
2524
2625
The annotation tells an auto-formatting function which unit is being used.
2726

0 commit comments

Comments
 (0)