From 983b2cc0157c22e7c88a2157cd7b2e7c10169a98 Mon Sep 17 00:00:00 2001 From: "Bryan W. Weber" Date: Tue, 3 Jan 2017 15:33:47 -0500 Subject: [PATCH] [Matlab/Doc] Fix typos in docs for some ThermoPhase getters These actually return scalars, although the docstrings said they returned vectors --- interfaces/matlab/toolbox/@ThermoPhase/cp_mass.m | 4 ++-- interfaces/matlab/toolbox/@ThermoPhase/cp_mole.m | 4 ++-- interfaces/matlab/toolbox/@ThermoPhase/cv_mass.m | 4 ++-- interfaces/matlab/toolbox/@ThermoPhase/cv_mole.m | 4 ++-- interfaces/matlab/toolbox/@ThermoPhase/enthalpy_mass.m | 2 +- interfaces/matlab/toolbox/@ThermoPhase/enthalpy_mole.m | 2 +- interfaces/matlab/toolbox/@ThermoPhase/entropy_mass.m | 2 +- interfaces/matlab/toolbox/@ThermoPhase/entropy_mole.m | 2 +- interfaces/matlab/toolbox/@ThermoPhase/gibbs_mass.m | 3 +-- interfaces/matlab/toolbox/@ThermoPhase/gibbs_mole.m | 3 +-- interfaces/matlab/toolbox/@ThermoPhase/intEnergy_mass.m | 3 +-- interfaces/matlab/toolbox/@ThermoPhase/intEnergy_mole.m | 3 +-- 12 files changed, 16 insertions(+), 20 deletions(-) diff --git a/interfaces/matlab/toolbox/@ThermoPhase/cp_mass.m b/interfaces/matlab/toolbox/@ThermoPhase/cp_mass.m index a436361ec..8f15b9d69 100644 --- a/interfaces/matlab/toolbox/@ThermoPhase/cp_mass.m +++ b/interfaces/matlab/toolbox/@ThermoPhase/cp_mass.m @@ -1,11 +1,11 @@ function v = cp_mass(tp) -% CP_MASS Get the mass-basis specific heats at constant pressure. +% CP_MASS Get the mass-basis specific heat at constant pressure. % v = cp_mass(tp) % :param tp: % Instance of class :mat:func:`ThermoPhase` (or another % object that derives from ThermoPhase) % :return: -% Vector of specific heats of the species at +% Molar basis specific heat of the mixture at % constant pressure. Units: J/kg-K % diff --git a/interfaces/matlab/toolbox/@ThermoPhase/cp_mole.m b/interfaces/matlab/toolbox/@ThermoPhase/cp_mole.m index c78cdc33e..bc0efe514 100644 --- a/interfaces/matlab/toolbox/@ThermoPhase/cp_mole.m +++ b/interfaces/matlab/toolbox/@ThermoPhase/cp_mole.m @@ -1,11 +1,11 @@ function v = cp_mole(tp) -% CP_MOLE Get the molar-basis specific heats at constant pressure. +% CP_MOLE Get the molar-basis specific heat at constant pressure. % v = cp_mole(tp) % :param tp: % Instance of class :mat:func:`ThermoPhase` (or another % object that derives from ThermoPhase) % :return: -% Vector of specific heats of the species at +% Molar basis specific heat of the mixture at % constant pressure. Units: J/kmol-K % diff --git a/interfaces/matlab/toolbox/@ThermoPhase/cv_mass.m b/interfaces/matlab/toolbox/@ThermoPhase/cv_mass.m index 7268ed928..978b3f9f6 100644 --- a/interfaces/matlab/toolbox/@ThermoPhase/cv_mass.m +++ b/interfaces/matlab/toolbox/@ThermoPhase/cv_mass.m @@ -1,11 +1,11 @@ function v = cv_mass(tp) -% CV_MASS Get the mass-basis specific heats at constant volume. +% CV_MASS Get the mass-basis specific heat at constant volume. % v = cv_mass(tp) % :param tp: % Instance of class :mat:func:`ThermoPhase` (or another % object that derives from ThermoPhase) % :return: -% Vector of specific heats of the species at +% Mass basis specific heat of the mixture at % constant volume. Units: J/kg-K % diff --git a/interfaces/matlab/toolbox/@ThermoPhase/cv_mole.m b/interfaces/matlab/toolbox/@ThermoPhase/cv_mole.m index 9d6084539..9663e7a53 100644 --- a/interfaces/matlab/toolbox/@ThermoPhase/cv_mole.m +++ b/interfaces/matlab/toolbox/@ThermoPhase/cv_mole.m @@ -1,11 +1,11 @@ function v = cv_mole(tp) -% CV_MOLE Get the molar-basis specific heats at constant volume. +% CV_MOLE Get the molar-basis specific heat at constant volume. % v = cv_mole(tp) % :param tp: % Instance of class :mat:func:`ThermoPhase` (or another % object that derives from ThermoPhase) % :return: -% Vector of specific heats of the species at +% Molar basis specific heat of the mixture at % constant volume. Units: J/kmol-K % diff --git a/interfaces/matlab/toolbox/@ThermoPhase/enthalpy_mass.m b/interfaces/matlab/toolbox/@ThermoPhase/enthalpy_mass.m index aa7cc2fd7..a62691375 100644 --- a/interfaces/matlab/toolbox/@ThermoPhase/enthalpy_mass.m +++ b/interfaces/matlab/toolbox/@ThermoPhase/enthalpy_mass.m @@ -5,7 +5,7 @@ function v = enthalpy_mass(tp) % Instance of class :mat:func:`ThermoPhase` (or another % object that derives from ThermoPhase) % :return: -% Vector of mass specific enthalpies of the species. Units: J/kg +% Mass specific enthalpy of the mixture. Units: J/kg % v = thermo_get(tp.tp_id, 9); diff --git a/interfaces/matlab/toolbox/@ThermoPhase/enthalpy_mole.m b/interfaces/matlab/toolbox/@ThermoPhase/enthalpy_mole.m index 15e4b3baf..168db9866 100644 --- a/interfaces/matlab/toolbox/@ThermoPhase/enthalpy_mole.m +++ b/interfaces/matlab/toolbox/@ThermoPhase/enthalpy_mole.m @@ -5,7 +5,7 @@ function v = enthalpy_mole(tp) % Instance of class :mat:func:`ThermoPhase` (or another % object that derives from ThermoPhase) % :return: -% Vector of molar specific enthalpies of the species. Units: J/kmol +% Molar specific enthalpy of the mixture. Units: J/kmol % v = thermo_get(tp.tp_id, 2); diff --git a/interfaces/matlab/toolbox/@ThermoPhase/entropy_mass.m b/interfaces/matlab/toolbox/@ThermoPhase/entropy_mass.m index f9b02ad2b..3b343f7ba 100644 --- a/interfaces/matlab/toolbox/@ThermoPhase/entropy_mass.m +++ b/interfaces/matlab/toolbox/@ThermoPhase/entropy_mass.m @@ -5,7 +5,7 @@ function v = entropy_mass(tp) % Instance of class :mat:func:`ThermoPhase` (or another % object that derives from ThermoPhase) % :return: -% Vector of mass specific entropies of the species. Units: J/kg-K +% Mass specific entropy of the mixture. Units: J/kg-K % v = thermo_get(tp.tp_id, 11); diff --git a/interfaces/matlab/toolbox/@ThermoPhase/entropy_mole.m b/interfaces/matlab/toolbox/@ThermoPhase/entropy_mole.m index 7b1bbf127..f42c12c0a 100644 --- a/interfaces/matlab/toolbox/@ThermoPhase/entropy_mole.m +++ b/interfaces/matlab/toolbox/@ThermoPhase/entropy_mole.m @@ -5,7 +5,7 @@ function v = entropy_mole(tp) % Instance of class :mat:func:`ThermoPhase` (or another % object that derives from ThermoPhase) % :return: -% Vector of molar specific entropies of the species. Units: J/kg +% Molar specific entropy of the mixture. Units: J/kg % v = thermo_get(tp.tp_id, 4); diff --git a/interfaces/matlab/toolbox/@ThermoPhase/gibbs_mass.m b/interfaces/matlab/toolbox/@ThermoPhase/gibbs_mass.m index e1173e0cb..14f167b18 100644 --- a/interfaces/matlab/toolbox/@ThermoPhase/gibbs_mass.m +++ b/interfaces/matlab/toolbox/@ThermoPhase/gibbs_mass.m @@ -5,8 +5,7 @@ function v = gibbs_mass(tp) % Instance of class :mat:func:`ThermoPhase` (or another % object that derives from ThermoPhase) % :return: -% Vector of mass specific Gibbs functions of the species. -% Units: J/kg +% Mass specific Gibbs function of the mixture. Units: J/kg % v = thermo_get(tp.tp_id, 12); diff --git a/interfaces/matlab/toolbox/@ThermoPhase/gibbs_mole.m b/interfaces/matlab/toolbox/@ThermoPhase/gibbs_mole.m index 66c37c4c9..093b431fa 100644 --- a/interfaces/matlab/toolbox/@ThermoPhase/gibbs_mole.m +++ b/interfaces/matlab/toolbox/@ThermoPhase/gibbs_mole.m @@ -5,8 +5,7 @@ function v = gibbs_mole(tp) % Instance of class :mat:func:`ThermoPhase` (or another % object that derives from ThermoPhase) % :return: -% Vector of mole specific Gibbs functions of the species. -% Units: J/kmol +% Molar specific Gibbs function of the mixture. Units: J/kmol % v = thermo_get(tp.tp_id, 5); diff --git a/interfaces/matlab/toolbox/@ThermoPhase/intEnergy_mass.m b/interfaces/matlab/toolbox/@ThermoPhase/intEnergy_mass.m index 476ab5c09..a5fea2027 100644 --- a/interfaces/matlab/toolbox/@ThermoPhase/intEnergy_mass.m +++ b/interfaces/matlab/toolbox/@ThermoPhase/intEnergy_mass.m @@ -5,8 +5,7 @@ function v = intEnergy_mass(tp) % Instance of class :mat:func:`ThermoPhase` (or another % object that derives from ThermoPhase) % :return: -% Vector of mass specific internal energies of the species. -% Units: J/kg +% Mass specific internal energy of the mixture. Units: J/kg % v = thermo_get(tp.tp_id, 10); diff --git a/interfaces/matlab/toolbox/@ThermoPhase/intEnergy_mole.m b/interfaces/matlab/toolbox/@ThermoPhase/intEnergy_mole.m index ee0a8b214..8df1556ad 100644 --- a/interfaces/matlab/toolbox/@ThermoPhase/intEnergy_mole.m +++ b/interfaces/matlab/toolbox/@ThermoPhase/intEnergy_mole.m @@ -5,8 +5,7 @@ function v = intEnergy_mole(tp) % Instance of class :mat:func:`ThermoPhase` (or another % object that derives from ThermoPhase) % :return: -% Vector of mole specific internal energies of the species. -% Units: J/kmol +% Molar specific internal energy of the mixture. Units: J/kmol % v = thermo_get(tp.tp_id, 3);