Skip to content

Commit d03d7ae

Browse files
authored
DOC: Correct typos across documentation (#1603)
Thank you to Jessica Garnett for finding and fixing these typos.
1 parent 996d7af commit d03d7ae

32 files changed

Lines changed: 73 additions & 73 deletions

docs/AnacondaPackages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
These builds can on the order of **multiple hours** to complete on x86 systems that predate Intel 13th Generation processors. Be patient. The build looks like it is stuck but python is just taking it's time to recursively figure out the needed DLLs because ITK and VTK create a ton of DLL libraries. This is especially slow on Windows systems.
66

7-
## Python Varitions
7+
## Python Variations
88

99
- 3.9
1010
- 3.10

docs/Build_From_Source.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ This example shows how to configure simplnx to build using Visual Studio IDE
7878

7979
```shell
8080
set BUILD_DIR=VisualStudio
81-
set VCPKG_INSTALL_ROOT=C:/Appications/vcpkg
81+
set VCPKG_INSTALL_ROOT=C:/Applications/vcpkg
8282
cd simplnx
8383
mkdir %BUILD_DIR%
8484
cd %BUILD_DIR%
@@ -87,15 +87,15 @@ cmake -G "Visual Studio 17 2022" -A x64 -DCMAKE_TOOLCHAIN_FILE=%VCPKG_INSTALL_RO
8787

8888
### Windows with Ninja and IDE of choice (QtCreator, CLion, command line)
8989

90-
Adjust the below commands to the sytle of your shell (The below example is done in Windows Command Prompt Batch file style).
90+
Adjust the below commands to the style of your shell (The below example is done in Windows Command Prompt Batch file style).
9191

92-
In this example we are building a Release version of compled into a directory called `Release` inside the source directory. We will be using the `ninja` generator so be sure that ninja.exe is on your PATH
92+
In this example we are building a Release version compiled into a directory called `Release` inside the source directory. We will be using the `ninja` generator so be sure that ninja.exe is on your PATH
9393

9494
```shell
9595
set NINJA_INSTALL=C:/Applications/ninja-win
9696
set PATH=%PATH%:%NINJA_INSTALL%
9797
set BUILD_DIR=Release
98-
set VCPKG_INSTALL_ROOT=C:/Appications/vcpkg
98+
set VCPKG_INSTALL_ROOT=C:/Applications/vcpkg
9999
cd simplnx
100100
mkdir %BUILD_DIR%
101101
cd %BUILD_DIR%
@@ -140,13 +140,13 @@ cmake -G Ninja -DCMAKE_TOOLCHAIN_FILE=$VCPKG_INSTALL_ROOT/scripts/buildsystems/v
140140

141141
| Identifier | Type | Explanation |
142142
|------------|------|-------------|
143-
| `ITKImageProcessing_USE_JOB_POOL` | `BOOL` | When `ON` the amount of threads used to build `ITK` library plugin is capped (see `ITKImageProcessing_JOB_POOL`). Some of the `ITK` files more 2+ GB of memory to compile due to heavy templating. This is to prevent sytems from running out of memory during compilation. |
143+
| `ITKImageProcessing_USE_JOB_POOL` | `BOOL` | When `ON` the amount of threads used to build `ITK` library plugin is capped (see `ITKImageProcessing_JOB_POOL`). Some of the `ITK` files more 2+ GB of memory to compile due to heavy templating. This is to prevent systems from running out of memory during compilation. |
144144
| `ITKImageProcessing_JOB_POOL` | `STRING` | If `ITKImageProcessing_USE_JOB_POOL` is `ON`, this variable is the maximum number of threads available to the `ITK` plugin during compilation. For example on a system with 32 threads and 64GB of RAM a value of `16` will prevent out-of-memory errors during compilation. |
145145
| `SIMPLNX_BUILD_TESTS` | `BOOL` | Turning this on will compile the filter/library tests and include them in the all ctests target |
146146
| `SIMPLNX_BUILD_DOCS` | `BOOL` | Turning this on will build the library/filters documentation, `SPHINX_BUILD_EXECUTABLE` must be defined |
147147
| `SPHINX_BUILD_EXECUTABLE` | `PATH` | The absolute path to to the sphinx executable; *required* for `SIMPLNX_BUILD_PYTHON_DOCS` and/or `SIMPLNX_BUILD_DOCS` |
148-
| `SIMPLNX_EXTRA_PLUGINS` | `STRING` | A list of plugin targets (separated by `;`) to include into the library. Currently the only offical additional plugin not bundled is `SimplnxReview` which is untested filters |
149-
| `SIMPLNX_ENABLE_BENCHMARK_UTILITY` | `BOOL` | Turning this on will include the preffered benchmarking library; Be sure to **add** `benchmark` **to** `VCPKG_MANIFEST_FEATURES` **list** |
148+
| `SIMPLNX_EXTRA_PLUGINS` | `STRING` | A list of plugin targets (separated by `;`) to include into the library. Currently the only official additional plugin not bundled is `SimplnxReview` which is untested filters |
149+
| `SIMPLNX_ENABLE_BENCHMARK_UTILITY` | `BOOL` | Turning this on will include the preferred benchmarking library; Be sure to **add** `benchmark` **to** `VCPKG_MANIFEST_FEATURES` **list** |
150150

151151
### Python Binding CMake Arguments
152152

docs/CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ------------------------------------------------------------------------------
22
# Building the Developer Documentation using Doxygen is probably not supported
33
# and has not been updated since 2021. This is being left in here for historical
4-
# reasons and incase someone wants to add this capability in the future.
4+
# reasons and in case someone wants to add this capability in the future.
55
# ------------------------------------------------------------------------------
66

77
option(SIMPLNX_BUILD_SPHINX_DOCS "Use Doxygen to build developer documentation (Not Supported)" OFF)

docs/Doxyfile.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -466,7 +466,7 @@ LOOKUP_CACHE_SIZE = 0
466466
# than 0 to get more control over the balance between CPU load and processing
467467
# speed. At this moment only the input processing can be done using multiple
468468
# threads. Since this is still an experimental feature the default is set to 1,
469-
# which efficively disables parallel processing. Please report any issues you
469+
# which effectively disables parallel processing. Please report any issues you
470470
# encounter. Generating dot graphs in parallel is controlled by the
471471
# DOT_NUM_THREADS setting.
472472
# Minimum value: 0, maximum value: 32, default value: 1.

docs/PortingFilters.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ folder.
7373

7474
The backwards compatibility will begin testing immediately as long as the filter is registered in the `PluginNameUUIDLegacyMapping.hpp` file. The only exception is new filters that have no **SIMPL** equivalent.
7575

76-
To run the test in advance select the `conversion_test` ctest target and run it. Most of the errors are from issues in the filter's `FromSIMPLJson()` function. The error messages should guide you towards a solution. The following cases are exceptions that can be hard to diagnose without apriori knowledge.
76+
To run the test in advance select the `conversion_test` ctest target and run it. Most of the errors are from issues in the filter's `FromSIMPLJson()` function. The error messages should guide you towards a solution. The following cases are exceptions that can be hard to diagnose without a priori knowledge.
7777

7878
How To Update Test For Filter Changes/Ports
7979

@@ -200,7 +200,7 @@ At the current time, the only filters that should be made parallel are those tha
200200
201201
### Syntax for Simplnx
202202
203-
This is an examplar use case and doesn't truly encompass all possible use cases for the functions, but instead serves to show how it should be structured in most cases.
203+
This is an exemplar use case and doesn't truly encompass all possible use cases for the functions, but instead serves to show how it should be structured in most cases.
204204
205205
In an anonymous namespace:
206206
```cpp
@@ -233,7 +233,7 @@ private:
233233
};
234234
```
235235

236-
In the exectuting function:
236+
In the executing function:
237237

238238
```cpp
239239
ParallelDataAlgorithm dataAlg;
@@ -275,7 +275,7 @@ For progress messaging a throttled messenger class is provided. To initialize it
275275
ThrottledMessenger throttledMessenger = messageHelper.createThrottledMessenger();
276276
```
277277

278-
The throttled messenger will print every 1000 milliseconds (1 second) by default, to change this intialize it as follows:
278+
The throttled messenger will print every 1000 milliseconds (1 second) by default, to change this initialize it as follows:
279279

280280
```cpp
281281
ThrottledMessenger throttledMessenger = messageHelper.createThrottledMessenger(static_cast<std::chrono::milliseconds>(number_in_milliseconds));

docs/dream3d_file_spec.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ These attributes are on every DataObject:
7272

7373
### Specific ObjectType Attributes
7474

75-
Based on the ObjectType, there can be additional attriutes that can be read based on the ObjectType value
75+
Based on the ObjectType, there can be additional attributes that can be read based on the ObjectType value
7676

7777
#### AttributeMatrix
7878

src/Plugins/ITKImageProcessing/src/ITKImageProcessing/Filters/ITKSigmoidImageFilter.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Parameters ITKSigmoidImageFilter::parameters() const
7979
Parameters params;
8080
params.insertSeparator(Parameters::Separator{"Input Parameter(s)"});
8181
params.insert(std::make_unique<Float64Parameter>(k_Alpha_Key, "Alpha", "The Alpha value from the Sigmoid equation. ", 1));
82-
params.insert(std::make_unique<Float64Parameter>(k_Beta_Key, "Beta", "The Beta value from teh sigmoid equation", 0));
82+
params.insert(std::make_unique<Float64Parameter>(k_Beta_Key, "Beta", "The Beta value from the sigmoid equation", 0));
8383
params.insert(std::make_unique<Float64Parameter>(k_OutputMaximum_Key, "Output Maximum", "The maximum output value", 255));
8484
params.insert(std::make_unique<Float64Parameter>(k_OutputMinimum_Key, "Output Minimum", "The minimum output value", 0));
8585

src/Plugins/OrientationAnalysis/src/OrientationAnalysis/Filters/Algorithms/ComputeFeatureReferenceMisorientations.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Result<> ComputeFeatureReferenceMisorientations::operator()()
7878
return MakeErrorResult(-34900, "Total features was zero. The filter cannot proceed. Check either the feature attribute matrix or the average quaternions for proper size");
7979
}
8080

81-
// Create local storage for teh centers and center distances
81+
// Create local storage for the centers and center distances
8282
std::vector<size_t> m_Centers(totalFeatures, 0);
8383
std::vector<float> m_CenterDistances(totalFeatures, 0.0f);
8484

src/Plugins/OrientationAnalysis/test/ComputeTwinBoundariesTest.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ TEST_CASE("OrientationAnalysis::ComputeTwinBoundariesFilter: No Incoherence", "[
143143

144144
// Compare the output arrays with those precalculated from the file
145145
{
146-
// The exemplar algorithm skips invalid values while this algorithm doesn't due to lack of apriori knowledge (face normals array) so we simulate it here
146+
// The exemplar algorithm skips invalid values while this algorithm doesn't due to lack of a priori knowledge (face normals array) so we simulate it here
147147
auto& faceNormals = dataStructure.getDataRefAs<Float64Array>(TwinBoundariesConstants::k_FaceNormalsPath);
148148
auto& exemplarBoundaries = dataStructure.getDataRefAs<UInt8Array>(TwinBoundariesConstants::k_ExemplarBoundariesPath);
149149
auto& generatedBoundaries = dataStructure.getDataRefAs<UInt8Array>(TwinBoundariesConstants::k_GeneratedBoundariesPath);

src/Plugins/SimplnxCore/docs/CreateDataArrayAdvancedFilter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The *Step Operation* parameter is active when *Initialization Type* is set to **
2424
- **Addition [0]**: Each successive element value is the previous value plus the step amount (ascending sequence).
2525
- **Subtraction [1]**: Each successive element value is the previous value minus the step amount (descending sequence).
2626

27-
When initializing a multicomponent array square bracket notation can be used to specify different initialization values for each component. For example say that I want to intialize a 2 component array where the first component is 0 and the second component is 1 we would use the following input string for the *Initialization Value*
27+
When initializing a multicomponent array square bracket notation can be used to specify different initialization values for each component. For example say that I want to initialize a 2 component array where the first component is 0 and the second component is 1 we would use the following input string for the *Initialization Value*
2828

2929
0;1
3030

0 commit comments

Comments
 (0)