From 65694916036ed1795a835177fc2476c204720c7c Mon Sep 17 00:00:00 2001
From: Victor Poughon <victor.poughon@cnes.fr>
Date: Fri, 4 Jan 2019 09:53:09 +0100
Subject: [PATCH] DOC: typos from code review
---
Documentation/Cookbook/Scripts/otb_warnings.py | 18 ------------------
.../app/otbKMeansClassification.cxx | 2 +-
2 files changed, 1 insertion(+), 19 deletions(-)
diff --git a/Documentation/Cookbook/Scripts/otb_warnings.py b/Documentation/Cookbook/Scripts/otb_warnings.py
index 457c440baf..61af6ff2b2 100644
--- a/Documentation/Cookbook/Scripts/otb_warnings.py
+++ b/Documentation/Cookbook/Scripts/otb_warnings.py
@@ -18,17 +18,6 @@ def parameter_warnings(app_warn, app, key):
if "." in name:
warn("name contains a special character (.)")
- # disabled because there are so many for now
- #if description == "":
- #warn("missing description")
-
- # disabled because there are so many for now
- #if len(description) > 0 and description[-1] != ".":
- #warn("description does not end with a period")
-
- #if len(description) > 0 and " :" in description:
- #warn("description has a space before a colon")
-
def application_documentation_warnings(app):
"Emit warnings about application documentation"
@@ -38,16 +27,9 @@ def application_documentation_warnings(app):
description = app.GetDescription()
longdescription = app.GetDocLongDescription()
- # disable because there are so many for now
- #if not longdescription[-1] == ".":
- #warn("Application Long Description does not end with a period (.)")
-
if re.search("\\n [a-zA-Z]", longdescription):
warn("Application Long Description contains '\\n ' pattern (usually not intended)")
- #if " :" in longdescription:
- #warn("Application Long Description has a space before a colon")
-
if app.GetNumberOfExamples() == 0:
warn("Application has no examples")
diff --git a/Modules/Applications/AppClassification/app/otbKMeansClassification.cxx b/Modules/Applications/AppClassification/app/otbKMeansClassification.cxx
index dc59be6383..7f77cb9893 100644
--- a/Modules/Applications/AppClassification/app/otbKMeansClassification.cxx
+++ b/Modules/Applications/AppClassification/app/otbKMeansClassification.cxx
@@ -417,7 +417,7 @@ private:
"4) SampleExtraction: extract the samples descriptors (update of SampleSelection output file),\n"
"5) ComputeImagesStatistics: compute images second order statistics,\n"
"6) TrainVectorClassifier: train the SharkKMeans model,\n"
- "7) ImageClassifier: performs the classification of the input image "
+ "7) ImageClassifier: perform the classification of the input image "
"according to a model file.\n\n"
"It's possible to choice random/periodic modes of the SampleSelection application.\n"
"If you want keep the temporary files (sample selected, model file, ...), "
--
GitLab