Minor style changes.

mlpack · May 12, 2019 · 328dd57 · 328dd57
1 parent a879b51
commit 328dd57
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 20 deletions.
diff --git a/src/mlpack/methods/adaboost/adaboost_main.cpp b/src/mlpack/methods/adaboost/adaboost_main.cpp
@@ -81,10 +81,11 @@ PROGRAM_INFO("AdaBoost",
     "model itself is output to the " + PRINT_PARAM_STRING("output_model") +
     " output parameter."
     "\n\n"
-    "Note : The following parameter is deprecated and "
+    "Note: the following parameter is deprecated and "
     "will be removed in mlpack 4.0.0: " + PRINT_PARAM_STRING("output") +
-    "."  +
-    "\nUse " + PRINT_PARAM_STRING("predictions") + " instead of " +
+    "."
+    "\n"
+    "Use " + PRINT_PARAM_STRING("predictions") + " instead of " +
     PRINT_PARAM_STRING("output") + '.' +
     "\n\n"
     "For example, to run AdaBoost on an input dataset " +
@@ -117,10 +118,7 @@ PARAM_UROW_IN("labels", "Labels for the training set.", "l");
 
 // Classification options.
 PARAM_MATRIX_IN("test", "Test dataset.", "T");
-/* 
-* The PARAM_UROW_OUT("output") is deprecated and will be removed in
-* mlpack 4.0.0.
-*/
+// PARAM_UROW_OUT("output") is deprecated and will be removed in mlpack 4.0.0.
 PARAM_UROW_OUT("output", "Predicted labels for the test set.", "o");
 PARAM_UROW_OUT("predictions", "Predicted labels for the test set.", "P");
 
@@ -169,7 +167,7 @@ static void mlpackMain()
   RequireAtLeastOnePassed({ "output_model", "output", "predictions" }, false,
       "no results will be saved");
 
-  // "output" can be removed in mlpack 4.0.0.
+  // "output" will be removed in mlpack 4.0.0.
   ReportIgnoredParam({{ "test", false }}, "predictions");
 
   AdaBoostModel* m;

diff --git a/src/mlpack/methods/perceptron/perceptron_main.cpp b/src/mlpack/methods/perceptron/perceptron_main.cpp
@@ -52,10 +52,11 @@ PROGRAM_INFO("Perceptron",
     " output parameter.  The perceptron model may be saved with the " +
     PRINT_PARAM_STRING("output_model") + " output parameter."
     "\n\n"
-    "Note: The following parameter is deprecated and "
+    "Note: the following parameter is deprecated and "
     "will be removed in mlpack 4.0.0: " + PRINT_PARAM_STRING("output") +
-    "."  +
-    "\nUse " + PRINT_PARAM_STRING("predictions") + " instead of " +
+    "."
+    "\n"
+    "Use " + PRINT_PARAM_STRING("predictions") + " instead of " +
     PRINT_PARAM_STRING("output") + '.' +
     "\n\n"
     "The training data given with the " + PRINT_PARAM_STRING("training") +
@@ -133,10 +134,7 @@ PARAM_MODEL_OUT(PerceptronModel, "output_model", "Output for trained perceptron"
 
 // Testing/classification parameters.
 PARAM_MATRIX_IN("test", "A matrix containing the test set.", "T");
-/* 
-* The PARAM_UROW_OUT("output") is deprecated and will be removed in
-* mlpack 4.0.0.
-*/
+// PARAM_UROW_OUT("output") is deprecated and will be removed in
 PARAM_UROW_OUT("output", "The matrix in which the predicted labels for the"
     " test set will be written.", "o");
 PARAM_UROW_OUT("predictions", "The matrix in which the predicted labels for the"
@@ -154,7 +152,7 @@ static void mlpackMain()
   // should issue a warning.
   RequireAtLeastOnePassed({ "output_model", "output", "predictions" }, false,
       "no output will be saved");
-  // "output" can be removed in mlpack 4.0.0.
+  // "output" will be removed in mlpack 4.0.0.
   ReportIgnoredParam({{ "test", false }}, "predictions");
 
   // Check parameter validity.

diff --git a/src/mlpack/tests/main_tests/adaboost_test.cpp b/src/mlpack/tests/main_tests/adaboost_test.cpp
@@ -205,9 +205,10 @@ BOOST_AUTO_TEST_CASE(AdaBoostTrainingDataOrModelTest)
   BOOST_REQUIRE_THROW(mlpackMain(), std::runtime_error);
   Log::Fatal.ignoreInput = false;
 }
+
 /**
- * This test can be removed in mlpack 4.0.0. Testing
- * the output and predictions outputs are the same.
+ * This test can be removed in mlpack 4.0.0.  This tests that the output and
+ * predictions outputs are the same.
  */
 BOOST_AUTO_TEST_CASE(AdaBoostOutputPredictionsTest)
 {

diff --git a/src/mlpack/tests/main_tests/perceptron_test.cpp b/src/mlpack/tests/main_tests/perceptron_test.cpp
@@ -163,8 +163,8 @@ BOOST_AUTO_TEST_CASE(PerceptronLabelsLessDimensionTest)
 }
 
 /**
- * This test can be removed in mlpack 4.0.0. Testing
- * the output and predictions outputs are the same.
+ * This test can be removed in mlpack 4.0.0. This tests that the output and
+ * predictions outputs are the same.
  */
 BOOST_AUTO_TEST_CASE(PerceptronOutputPredictionsCheck)
 {