Minor adjustments to docstrings (#118)

Aalto-Electric-Drives · Apr 18, 2024 · 19a297b · 19a297b
1 parent 0656fcd
commit 19a297b
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 11 deletions.
diff --git a/examples/flux_vector/plot_flux_vector_pmsyrm_5kw.py b/examples/flux_vector/plot_flux_vector_pmsyrm_5kw.py
@@ -192,7 +192,6 @@ def i_s(psi_s):
 # %%
 # .. rubric:: References
 #
-# .. [#Lel2024] Francesco Lelli, Marko Hinkkanen, Fabio Giulii Capponi. A
-#    Saturation Model Based on a Simplified Equivalent Magnetic Circuit for
-#    Permanent Magnet Machines. TechRxiv. April 17, 2024,
-#    DOI: 10.36227/techrxiv.171332345.53790692/v1
+# .. [#Lel2024] Lelli, Hinkkanen, Giulii Capponi, "A saturation model based on
+#    a simplified equivalent magnetic circuit for permanent magnet machines,"
+#    TechRxiv., 2024, https://doi.org/10.36227/techrxiv.171332345.53790692/v1
diff --git a/motulator/control/im/_observers.py b/motulator/control/im/_observers.py
@@ -7,8 +7,7 @@
 # %%
 class Observer:
     """
-    Reduced-order flux observer for induction machines in estimated 
-    rotor flux coordinates.
+    Reduced-order flux observer in estimated rotor flux coordinates.
 
     This class implements a reduced-order flux observer for induction machines.
     Both sensored and sensorless operation are supported. The observer 
@@ -149,8 +148,7 @@ def __call__(self, T_s, u_s, i_s, w_m=None):
 
 class FullOrderObserver:
     """
-    Full-order flux observer for induction machines in estimated 
-    rotor flux coordinates.
+    Full-order flux observer in estimated rotor flux coordinates.
 
     This class implements a full-order flux observer for induction machines. 
     The observer structure is similar to [#Tii2023]_. The observer operates in 
@@ -216,7 +214,7 @@ def __init__(
                     self.alpha - 1j*w_m)
         else:
             raise NotImplementedError(
-                "Sensored mode not implemented for full-order observer")
+                "Sensored mode not implemented for this full-order observer")
 
         # States
         self.psi_R, self.i_s, self.theta_s, self.w_m = 0, 0, 0, 0

diff --git a/motulator/control/sm/_vector.py b/motulator/control/sm/_vector.py
@@ -369,7 +369,7 @@ def limit_torque(tau_M_ref, w_m, u_dc):
 
     def update(self, T_s, tau_M_ref_lim, u_s_ref, u_dc):
         """
-        Field-weakening based on the unlimited reference voltage.
+        Field-weakening control based on the unlimited reference voltage.
 
         Parameters
         ----------

diff --git a/motulator/model/im/_drive.py b/motulator/model/im/_drive.py
@@ -42,7 +42,7 @@ class InductionMachine:
     References
     ----------
     .. [#Sle1989] Slemon, "Modelling of induction machines for electric 
-       drives," IEEE Trans. Ind. Appl., 1989, https://doi.org/10.1109/28.44251.
+       drives," IEEE Trans. Ind. Appl., 1989, https://doi.org/10.1109/28.44251
 
     """