#216 Fix typos

dynawo · Dec 9, 2021 · 1413410 · 1413410
1 parent c57cae4
commit 1413410
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/sources/Inputs/include/Node.h b/sources/Inputs/include/Node.h
@@ -141,13 +141,13 @@ class Tfo {
 /// @brief Topological shunt
 struct Shunt {
   using ShuntId = std::string;  ///< alias for shunt id
-  using BusId = std::string;    ///< Alias for bus id regulated by the shunt
+  using BusId = std::string;    ///< Alias for bus id connected to the shunt
 
   /**
    * @brief Construct a new Shunt
    *
    * @param id the shunt id
-   * @param busId the bus regulated by the shunt
+   * @param busId the connected bus id
    * @param targetV the target voltage of the shunt
    * @param voltageRegulationOn whether voltage regulation is enabled for the shunt
    * @param bs the vector of the susceptance values for the shunt
@@ -177,7 +177,7 @@ struct Shunt {
   const BusId busId;                    ///< the connected bus of the shunt
   const double targetV;                 ///< the target V of the shunt
   const bool voltageRegulationOn;       ///< whether voltage regulation is enabled for the shunt
-  const std::vector<double> bSections;  ///< the vector of the B values for the shunt
+  const std::vector<double> bSections;  ///< the vector of the susceptance values for the shunt
   const unsigned int sectionNumber;     ///< initial section index in sections
 };
 

diff --git a/sources/Outputs/include/Constants.h b/sources/Outputs/include/Constants.h
@@ -97,7 +97,7 @@ const std::string propSignalNGeneratorFixedPParId{"propSignalNGeneratorFixedP"};
 const std::string remoteVControlParId{"remoteVControl"};                          ///< PAR id for using remote voltage control
 const std::string remoteSignalNGeneratorFixedP{"remoteSignalNFixedP"};            ///< PAR id for using remote signal N with fixed P
 const std::string xmlEncoding{"UTF-8"};                                           ///< Default encoding for XML outputs files
-const std::string diagramTableBPu{"tableBPu"};                                    ///< Name of the table in b sections diagram files
+const std::string diagramTableBPu{"tableBPu"};                                    ///< Name of the table in susceptance sections diagram files
 
 constexpr double powerValueMax = std::numeric_limits<double>::max();  ///< Maximum value for powers, meaning infinite