[mlpack-git] master: Update documentation: program no longer exits. (9a55cac)

[gitdub at big.cc.gt.atl.ga.us]

Repository : https://github.com/mlpack/mlpack

On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/8732174b48830f462a9a1e166128ec17cf17db8b...9a55cac0229c9d469db3f6ff01cd0fb2985aa599

>---------------------------------------------------------------

commit 9a55cac0229c9d469db3f6ff01cd0fb2985aa599
Author: ryan <ryan at ratml.org>
Date:   Tue Apr 14 10:08:07 2015 -0400

    Update documentation: program no longer exits.


>---------------------------------------------------------------

9a55cac0229c9d469db3f6ff01cd0fb2985aa599
 src/mlpack/core/data/load.hpp | 11 ++++++-----
 src/mlpack/core/data/save.hpp | 10 +++++-----
 2 files changed, 11 insertions(+), 10 deletions(-)

diff --git a/src/mlpack/core/data/load.hpp b/src/mlpack/core/data/load.hpp
index 72b847e..0e06e01 100644
--- a/src/mlpack/core/data/load.hpp
+++ b/src/mlpack/core/data/load.hpp
@@ -36,11 +36,12 @@ namespace data /** Functions to load and save matrices. */ {
  * This is preferable to Armadillo's default behavior of loading an unknown
  * filetype as raw_binary, which can have very confusing effects.
  *
- * If the parameter 'fatal' is set to true, the program will exit with an error
- * if the matrix does not load successfully.  The parameter 'transpose' controls
- * whether or not the matrix is transposed after loading.  In most cases,
- * because data is generally stored in a row-major format and MLPACK requires
- * column-major matrices, this should be left at its default value of 'true'.
+ * If the parameter 'fatal' is set to true, a std::runtime_error exception will
+ * be thrown if the matrix does not load successfully.  The parameter
+ * 'transpose' controls whether or not the matrix is transposed after loading.
+ * In most cases, because data is generally stored in a row-major format and
+ * mlpack requires column-major matrices, this should be left at its default
+ * value of 'true'.
  *
  * @param filename Name of file to load.
  * @param matrix Matrix to load contents of file into.
diff --git a/src/mlpack/core/data/save.hpp b/src/mlpack/core/data/save.hpp
index 840b455..6b70017 100644
--- a/src/mlpack/core/data/save.hpp
+++ b/src/mlpack/core/data/save.hpp
@@ -33,11 +33,11 @@ namespace data /** Functions to load and save matrices. */ {
  *  - HDF5 (hdf5_binary), denoted by .hdf5, .hdf, .h5, or .he5
  *
  * If the file extension is not one of those types, an error will be given.  If
- * the 'fatal' parameter is set to true, an error will cause the program to
- * exit.  If the 'transpose' parameter is set to true, the matrix will be
- * transposed before saving.  Generally, because MLPACK stores matrices in a
- * column-major format and most datasets are stored on disk as row-major, this
- * parameter should be left at its default value of 'true'.
+ * the 'fatal' parameter is set to true, a std::runtime_error exception will be
+ * thrown upon failure.  If the 'transpose' parameter is set to true, the matrix
+ * will be transposed before saving.  Generally, because mlpack stores matrices
+ * in a column-major format and most datasets are stored on disk as row-major,
+ * this parameter should be left at its default value of 'true'.
  *
  * @param filename Name of file to save to.
  * @param matrix Matrix to save into file.