Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Ingmar Schoegl <ischoegl@lsu.edu>
  • Loading branch information
speth and ischoegl committed May 30, 2022
1 parent 3caf262 commit 8fbb4bc
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion doc/sphinx/yaml/general.rst
Expand Up @@ -91,7 +91,7 @@ explicitly in the units that a value is being converted to within Cantera. For
example, a conversion to ``N/m^2`` will use the default units for mass, length,
and time, while a conversion to ``Pa`` will use the default units for pressure.

Activation energies given in temperature units will be implicit converted to energy per
Activation energies given in temperature units will be implicitly converted to energy per
quantity by dividing by the gas constant. Activation energies given in pure energy units
such as eV will be converted to energy per quantity by multiplying by the Avogadro
constant. Setting default units for ``energy`` and ``quantity`` will determine the
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/base/logger.h
Expand Up @@ -70,7 +70,7 @@ class Logger
//! Write a warning message.
/*!
* The default behavior is to write to the logging output.
* @param warning String specifying type of warning; See Logger::warn
* @param warning String specifying type of warning
* @param msg String message to be written to cout
*/
virtual void warn(const std::string& warning, const std::string& msg) {
Expand Down
2 changes: 1 addition & 1 deletion include/cantera/kinetics/BlowersMaselRate.h
Expand Up @@ -169,7 +169,7 @@ class BlowersMaselRate : public ArrheniusBase

//! Set current enthalpy change of reaction [J/kmol]
/*!
* @note used for testing purposes only; This quantity is not an
* @note used for testing purposes only; this quantity is not an
* independent variable and will be overwritten during an update of the state.
*
* @warning This method is an experimental part of the %Cantera API and
Expand Down
4 changes: 2 additions & 2 deletions src/base/application.h
Expand Up @@ -137,7 +137,7 @@ class Application

//! Write a warning message to the screen.
/*!
* @param warning String specifying type of warning; See Logger::warn
* @param warning String specifying type of warning; see Logger::warn()
* @param msg String to be written to the screen
* @ingroup textlogs
*/
Expand Down Expand Up @@ -323,7 +323,7 @@ class Application
}

//! Generate a general purpose warning; repeated warnings are not suppressed
//! @param warning Warning type; See Logger::warn
//! @param warning Warning type; see Logger::warn()
//! @param method Name of method triggering the warning
//! @param extra Additional information printed for the warning
void warn(const std::string& warning,
Expand Down

0 comments on commit 8fbb4bc

Please sign in to comment.