[mlpack-git] master: Tiny minor documentation changes. (325348b)

gitdub at big.cc.gt.atl.ga.us gitdub at big.cc.gt.atl.ga.us
Thu Nov 19 11:35:00 EST 2015


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

On branch  : master
Link       : https://github.com/mlpack/mlpack/compare/713fa60a06f709bc715c4dd88f6ba585796f73a0...319205b2f3103187c584db302b1a3683aa2fbfdf

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

commit 325348b0d2827463debf224924a67785b77418db
Author: Ryan Curtin <ryan at ratml.org>
Date:   Tue Nov 17 17:26:06 2015 -0500

    Tiny minor documentation changes.


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

325348b0d2827463debf224924a67785b77418db
 doc/guide/timer.hpp             | 2 +-
 src/mlpack/core/util/timers.hpp | 8 +++++---
 2 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/doc/guide/timer.hpp b/doc/guide/timer.hpp
index 9d606e8..5a92162 100644
--- a/doc/guide/timer.hpp
+++ b/doc/guide/timer.hpp
@@ -31,7 +31,7 @@ Each timer is given a name, and is referenced by that name.  You can call \c
 Timer::Start() and \c Timer::Stop() multiple times for a particular timer name,
 and the result will be the sum of the runs of the timer.  Note that \c
 Timer::Stop() must be called before \c Timer::Start() is called again,
-otherwise runtime_error exception will occur.
+otherwise a std::runtime_error exception will be thrown.
 
 A "total_time" timer is run by default for each MLPACK program.
 
diff --git a/src/mlpack/core/util/timers.hpp b/src/mlpack/core/util/timers.hpp
index 9c840ce..b5f3db6 100644
--- a/src/mlpack/core/util/timers.hpp
+++ b/src/mlpack/core/util/timers.hpp
@@ -68,7 +68,8 @@ class Timer
    * both runs -- that is, MLPACK timers are additive for each time they are
    * run, and do not reset.
    *
-   * @note Runtime error exception will occur if a timer is started twice.
+   * @note A std::runtime_error exception will be thrown if a timer is started
+   * twice.
    *
    * @param name Name of timer to be started.
    */
@@ -77,7 +78,8 @@ class Timer
   /**
    * Stop the given timer.
    *
-   * @note Runtime error exception will occur if a timer is stopped twice.
+   * @note A std::runtime_error exception will be thrown if a timer is started
+   * twice.
    *
    * @param name Name of timer to be stopped.
    */
@@ -145,6 +147,6 @@ class Timers
   void GetTime(timeval* tv);
 };
 
-}; // namespace mlpack
+} // namespace mlpack
 
 #endif // __MLPACK_CORE_UTILITIES_TIMERS_HPP



More information about the mlpack-git mailing list