Skip to content

Commit

Permalink
DOC: Fix typos and improve wording in module descriptions
Browse files Browse the repository at this point in the history
Fix typos, improve wording, and remove duplicate whitespaces in module
descriptions.
  • Loading branch information
jhlegarreta authored and dzenanz committed Sep 26, 2022
1 parent e99bebe commit 604237d
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 11 deletions.
2 changes: 1 addition & 1 deletion CMake/ITKModuleRemote.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ endfunction()
# [GIT_REPOSITORY url] # URL of git repo
# [GIT_TAG tag] # Git branch name, commit id or tag
#
# An CMake variable Module_${name}_GIT_TAG can be set
# A CMake variable Module_${name}_GIT_TAG can be set
# in to override the value in the remote module configuration file.
# The intent of the Module_${name}_GIT_TAG variable override is to
# facilitate testing of remote module branch behaviors without
Expand Down
12 changes: 6 additions & 6 deletions Modules/Core/QuadEdgeMesh/itk-module.cmake
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
set(DOCUMENTATION "The QuadEdgeMesh module contain a specialized set of Mesh
classes intended to represent 2-manifolds embedded in a nD space. This family
of classes provides a consistent representation of oriented surfaces and
therefore they are used as a base for implementing common mesh filters and
operations. They are commonly used for representing the output of image
segmentation algorithms.
classes intended to represent 2-manifolds embedded in a N-Dimensional space.
This family of classes provides a consistent representation of oriented
surfaces and therefore they are used as a base for implementing common mesh
filters and operations. They are commonly used for representing the output of
image segmentation algorithms.
Some QuadEdgeMesh algorithms are based on iterating various connectivity
operators e.g. curvature driven surface deformation. Many of those connectivity
Expand Down Expand Up @@ -66,7 +66,7 @@ With those criteria in mind the following choices were made:
implemented as derived classes of itk::MeshFunctionBase. Still the mesh
modifications are really limited and concern a couple edges.
- More specialized methods, with a wider scope and that require a
copy of the mesh should follow the classical ITK Filter pattern and inherit
copy of the mesh should follow the classical ITK filter pattern and inherit
from itk::MeshToMeshFilter.")

itk_module(ITKQuadEdgeMesh
Expand Down
2 changes: 1 addition & 1 deletion Modules/Filtering/Colormap/itk-module.cmake
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
set(DOCUMENTATION "This module contains filter/functions for converting
grayscale images to colormapped rgb images.")
grayscale images to colormapped RGB images.")

itk_module(ITKColormap
ENABLE_SHARED
Expand Down
4 changes: 2 additions & 2 deletions Modules/Numerics/Statistics/itk-module.cmake
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
set(DOCUMENTATION "The Statistics module contains basic data structures,
statistical algorithms, and a classification for general statistical analysis
and classification problems. This includes, for examples, classes for
and classification problems. This includes, for example, classes for
calculating histograms, calculating sample statistics, creating decision rules,
or for performing statistical pattern classification. Statistics are calculated
or for performing statistical pattern classification. Statistics are calculated
on an itk::Sample, which contains measurement vectors.")

itk_module(ITKStatistics
Expand Down
1 change: 0 additions & 1 deletion Modules/Remote/HigherOrderAccurateGradient.remote.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@
itk_fetch_module(HigherOrderAccurateGradient
"This module contains a filter to compute higher order
accurate numerical derivatives and gradients from an input scalar image.
field from a displacement field image.
Higher Order Accurate Derivative and Gradient Calculation in ITK
https://www.insight-journal.org/browse/publication/775"
MODULE_COMPLIANCE_LEVEL 2
Expand Down

0 comments on commit 604237d

Please sign in to comment.