docs: fix minor errors for consistency

EscapedGibbon · stropitek · commit 4f45f5ed02c2 · 2023-10-13T09:19:25.000+02:00
diff --git a/docs/Features/Comparison/add.md b/docs/Features/Comparison/add.md
@@ -4,7 +4,7 @@
 This method works only with images.
 :::
 
-Method called `add`, opposed to [`subtract`](./subtract.md 'internal link on subtract'), takes another Image and makes an addition between each respective pixel.
+Add method, opposed to [subtract](./subtract.md 'internal link on subtract'), takes another Image and makes an addition between each respective pixel value.
 It works like this:
 
 ```ts
@@ -14,7 +14,7 @@ let mask = new Image(3, 3, {
 let mask2 = new Image(3, 3, {
   data: new Uint8Array([1, 133, 133, 133, 0, 0, 50, 0, 1]),
 });
-mask = mask.subtract(mask2);
+mask = mask.add(mask2);
 // expect mask to equal [2,255,255,255,255,122,1,51,2]
 ```
 
diff --git a/docs/Features/Comparison/hypotenuse.md b/docs/Features/Comparison/hypotenuse.md
@@ -10,7 +10,7 @@ $$
 NewValue = \sqrt{Value1^2+Value2^2}
 $$
 
-Where $$Value1$$ is a value of the pixel in the first image and $$Value2$$ is the value in the second one. The goal is to identify which points in one image correspond to points in another image, which is essential for various computer vision and image processing applications. Calculating hypotenuse value between two pixels is also necessary for image aligning and feature matching.
+Where $$Value1$$ is a value of the pixel in the first image and $$Value2$$ is the value of the second one. The goal is to identify which points in one image correspond to points in another image, which is essential for various computer vision and image processing applications. Calculating hypotenuse value between two pixels is also necessary for image aligning and feature matching.
 
 ### Parameters and default values
 
diff --git a/docs/Features/Comparison/subtract.md b/docs/Features/Comparison/subtract.md
@@ -20,9 +20,9 @@ Both masks must have the same size for compatibility reasons. Images must have t
 
 ### Parameters and default values
 
-- [`other`](https://image-js.github.io/image-js-typescript/classes/Mask.html#subtract 'github.io link')
+- `other`
 
-- [`options`](https://image-js.github.io/image-js-typescript/classes/Mask.html#subtract 'github.io link')
+- `options`
 
 #### Options
 
diff --git a/docs/Features/Filters/Blur.md b/docs/Features/Filters/Blur.md
@@ -3,7 +3,7 @@ import BlurDemo from './blur.demo.tsx'
 [Check options and parameters of blur method](https://image-js.github.io/image-js-typescript/classes/Image.html#blur 'link on github io')
 
 :::caution
-This method only works with images.
+This method works only with images.
 :::
 
 Blur, also known as average blur or box blur, is a simple image processing technique used to reduce noise and smooth out images. It involves replacing the color value of a pixel with the average color value of its neighboring pixels within a specified window or kernel. This process effectively blurs the image and reduces high-frequency noise.
diff --git a/docs/Features/Filters/Derivative.md b/docs/Features/Filters/Derivative.md
@@ -4,7 +4,7 @@ import GradientDemo from './gradient.demo.tsx'
 [Check options and parameters of derivative method](https://image-js.github.io/image-js-typescript/classes/Image.html#derivativeFilter 'link on github io')
 
 :::caution
-This method only works with images.
+This method works only with images.
 :::
 
 Derivative filter is a special case of a gradient filter, therefore it uses gradient algorithm. However, the key difference are the kernels used in this very algorithm. In ImageJS there are three distinguished kernels: [Sobel](https://en.wikipedia.org/wiki/Sobel_operator 'wikipedia link on Sobel kernel'), [Scharr](https://en.wikipedia.org/wiki/Sobel_operator#Alternative_operators 'wikipedia link on Scharr operator') and [Prewitt](https://en.wikipedia.org/wiki/Prewitt_operator 'wikipedia link on Prewitt kernel').
diff --git a/docs/Features/Filters/Gradient.md b/docs/Features/Filters/Gradient.md
@@ -7,7 +7,7 @@ import GradientDemo from './gradient.demo.tsx'
 [Check options and parameters of gradient method](https://image-js.github.io/image-js-typescript/functions/gradientFilter.html 'link on github.io')
 
 :::caution
-This method only works with images.
+This method works only with images.
 :::
 
 Gradient filter or specifically[ a gradient-based edge detection filter](https://en.wikipedia.org/wiki/Graduated_neutral-density_filter 'Wikipedia link on gradient filter'), is an image processing technique used to highlight edges and boundaries within an image by emphasizing areas of rapid intensity change. The gradient filter operates by calculating the rate of change of pixel intensities across the image. When there's a rapid transition from one intensity level to another, [the convolution operation](../../Glossary.md#convolution 'glossary link on convolution') captures this change as a high gradient magnitude value, indicating the presence of an edge. It's a fundamental step in various computer vision and image analysis tasks, such as edge detection, object recognition, and image segmentation.
diff --git a/docs/Features/Filters/Invert.md b/docs/Features/Filters/Invert.md
@@ -2,7 +2,7 @@ import InvertDemo from './invert.demo.tsx'
 
 [Check options and parameters of invert method](https://image-js.github.io/image-js-typescript/classes/Image.html#invert 'github.io link')
 
-[The invert filter](<https://en.wikipedia.org/wiki/Negative_(photography)> 'wikipedia link on negative filtering') is an image processing technique used to reverse the color values of an image, creating a negative or "inverted" version of the original. In this process, the darkest areas become the lightest, and the lightest areas become the darkest, while the midtones are adjusted accordingly. The invert filter is a simple but effective way to create visual contrast and produce interesting effects.
+[Invert filter](<https://en.wikipedia.org/wiki/Negative_(photography)> 'wikipedia link on negative filtering') is an image processing technique used to reverse the color values of an image, creating a negative or "inverted" version of the original. In this process, the darkest areas become the lightest, and the lightest areas become the darkest, while the midtones are adjusted accordingly. The invert filter is a simple but effective way to create visual contrast and produce interesting effects.
 
 <InvertDemo />
 
diff --git a/docs/Features/Filters/Median.md b/docs/Features/Filters/Median.md
@@ -3,10 +3,10 @@ import MedianDemo from './median.demo.tsx'
 [Check options and parameters of median method](https://image-js.github.io/image-js-typescript/classes/Image.html#medianFilter 'github.io link')
 
 :::caution
-This method only works with images.
+This method works only with images.
 :::
 
-[A median filter](https://en.wikipedia.org/wiki/Median_filter 'wikipedia link on median filter') is a digital image processing technique used to reduce noise in an image by replacing each pixel's value with the median value of neighboring pixels. It's particularly effective at removing ["salt and pepper"](https://en.wikipedia.org/wiki/Salt-and-pepper_noise 'Wikipedia link on salt and pepper effect') noise.
+[Median filter](https://en.wikipedia.org/wiki/Median_filter 'wikipedia link on median filter') is a digital image processing technique used to reduce noise in an image by replacing each pixel's value with the median value of neighboring pixels. It's particularly effective at removing ["salt and pepper"](https://en.wikipedia.org/wiki/Salt-and-pepper_noise 'Wikipedia link on salt and pepper effect') noise.
 
 <MedianDemo />
 
diff --git a/docs/Features/Filters/Pixelate.md b/docs/Features/Filters/Pixelate.md
@@ -3,7 +3,7 @@ import PixelateDemo from './pixelate.demo.tsx'
 [Check options and parameters of pixelate method](https://image-js.github.io/image-js-typescript/classes/Image.html#pixelate 'github.io link')
 
 :::caution
-This method only works with images.
+This method works only with images.
 :::
 
 [Pixelate filter](https://en.wikipedia.org/wiki/Pixelization 'Wikipedia link on pixelization concept') is a digital image processing technique used to reduce the level of detail in an image by replacing groups of pixels with a single, average color value. This creates a mosaic-like effect where the image appears to be composed of larger, blocky elements rather than fine details.
diff --git a/docs/Features/Filters/and.md b/docs/Features/Filters/and.md
@@ -1,7 +1,7 @@
 [Check options and parameters of and method](https://image-js.github.io/image-js-typescript/classes/Mask.html#and 'github.io link')
 
 :::caution
-This method only works with masks.
+This method works only with masks.
 :::
 
 `and` method performs a [logical conjunction](https://en.wikipedia.org/wiki/Logical_conjunction 'wikipedia link on logical conjunction') between bits of two masks.
@@ -21,6 +21,12 @@ Masks must have the same size for compatibility reasons.
 
 ### Parameters and default values
 
-- [`mask`](https://image-js.github.io/image-js-typescript/classes/Mask.html#and 'github.io link')
+- `mask`
 
-- [`options`](https://image-js.github.io/image-js-typescript/classes/Mask.html#and 'github.io link')
+- `options`
+
+#### Options
+
+| Property                                                                               | Required | Default value |
+| -------------------------------------------------------------------------------------- | -------- | ------------- |
+| [`out`](https://image-js.github.io/image-js-typescript/interfaces/AndOptions.html#out) | no       | -             |
diff --git a/docs/Features/Filters/gaussianBlur.md b/docs/Features/Filters/gaussianBlur.md
@@ -7,7 +7,7 @@ import GaussianBlurDemo from './gaussianBlur.demo.tsx'
 [Check options and parameters of gaussian blur method](https://image-js.github.io/image-js-typescript/classes/Image.html#gaussianBlur 'link on github io')
 
 :::caution
-This method only works with images.
+This method works only with images.
 :::
 
 [Gaussian blur](https://en.wikipedia.org/wiki/Gaussian_blur 'Wikipedia link on gaussian blur') is a widely used image processing technique that smooths an image by reducing high-frequency noise and fine details while preserving the overall structure and larger features. It's named after the [Gaussian function](https://en.wikipedia.org/wiki/Gaussian_function 'wikipedia link on Gaussian function'), which is a mathematical function that represents a bell-shaped curve. Gaussian blur is often applied to images before other processing steps like edge detection to improve their quality and reliability.
diff --git a/docs/Features/Filters/grayscale.md b/docs/Features/Filters/grayscale.md
@@ -3,10 +3,10 @@ import GrayDemo from './grayscale.demo.tsx'
 [Check options and parameters of grayscale method](https://image-js.github.io/image-js-typescript/classes/Image.html#grey 'github.io link')
 
 :::caution
-This method only works with images.
+This method works only with images.
 :::
 
-[A grayscale filter](https://en.wikipedia.org/wiki/Grayscale 'Wikipedia link on grayscale filter'), often called a black-and-white filter, is an image processing technique used to convert a colored image into a grayscale version. In a grayscale image, each pixel is represented by a single intensity value, typically ranging from 0 (black) to 255 (white), with various shades of gray in between. This process removes color information and retains only the brightness information of the image.
+[Grayscale filter](https://en.wikipedia.org/wiki/Grayscale 'Wikipedia link on grayscale filter'), often called a black-and-white filter, is an image processing technique used to convert a colored image into a grayscale version. In a grayscale image, each pixel is represented by a single intensity value, typically ranging from 0 (black) to 255 (white), with various shades of gray in between. This process removes color information and retains only the brightness information of the image.
 
 <GrayDemo />
 
diff --git a/docs/Features/Filters/level.md b/docs/Features/Filters/level.md
@@ -3,10 +3,10 @@ import LevelDemo from './level.demo.tsx'
 [Check options and parameters of level method](https://image-js.github.io/image-js-typescript/classes/Image.html#level 'github.io link')
 
 :::caution
-This method only works with images.
+This method works only with images.
 :::
 
-`level` method applies process called ["histogram equalization"](https://en.wikipedia.org/wiki/Histogram_equalization 'wikipedia link on histogram equalization').
+Level method applies process called ["histogram equalization"](https://en.wikipedia.org/wiki/Histogram_equalization 'wikipedia link on histogram equalization').
 Histogram equalization is a technique used in image processing to enhance the contrast and visibility of details in an image by redistributing the pixel intensity values.
 This process can make details in both dark and bright regions of the image more visible.
 
diff --git a/docs/Features/Filters/or.md b/docs/Features/Filters/or.md
@@ -1,4 +1,4 @@
-[Check options and parameters of level method](https://image-js.github.io/image-js-typescript/classes/Image.html#level 'github.io link')
+[Check options and parameters of or method](https://image-js.github.io/image-js-typescript/classes/Mask.html#or 'github.io link')
 
 :::caution
 This method works only with masks
@@ -21,6 +21,12 @@ Masks must have the same size for compatibility reasons.
 
 ### Parameters and default values
 
-- [`mask`](https://image-js.github.io/image-js-typescript/classes/Mask.html#or 'github.io link')
+- `mask`
 
-- [`options`](https://image-js.github.io/image-js-typescript/classes/Mask.html#or 'github.io link')
+- `options`
+
+#### Options
+
+| Property                                                                              | Required | Default value |
+| ------------------------------------------------------------------------------------- | -------- | ------------- |
+| [`out`](https://image-js.github.io/image-js-typescript/interfaces/OrOptions.html#out) | no       | -             |
diff --git a/docs/Features/Geometry/Rotate.md b/docs/Features/Geometry/Rotate.md
@@ -8,4 +8,4 @@ Rotating images in image processing involves changing the orientation of the ima
 
 ### Parameters and its default values
 
-- [RotateAngle](https://image-js.github.io/image-js-typescript/types/RotateAngle.html)
+- `RotateAngle`
diff --git a/docs/Features/Geometry/flip.md b/docs/Features/Geometry/flip.md
@@ -6,7 +6,7 @@ import FlipDemo from './flip.demo.tsx'
 This method works only with images.
 :::
 
-A "flip filter" in image processing refers to a transformation that horizontally or vertically flips an image. This operation is also known as a "mirror" operation. Flipping an image horizontally means reversing the order of pixels in each row, while flipping vertically means reversing the order of pixels in each column.
+Flip filter in image processing refers to a transformation that horizontally or vertically flips an image. This operation is also known as a "mirror" operation. Flipping an image horizontally means reversing the order of pixels in each row, while flipping vertically means reversing the order of pixels in each column.
 
 <FlipDemo />
 
diff --git a/docs/Features/Geometry/transform.md b/docs/Features/Geometry/transform.md
@@ -21,9 +21,9 @@ Matrix cannot be singular. Otherwise it cannot be inverted. Click [here](https:/
 
 ### Parameters and its default values
 
-- [transformMatrix](https://image-js.github.io/image-js-typescript/classes/Image.html#transform)
+- `transformMatrix`
 
-- [options](https://image-js.github.io/image-js-typescript/interfaces/TransformOptions.html)
+- `options`
 
 #### Options
 
diff --git a/docs/Features/Geometry/transformRotate.md b/docs/Features/Geometry/transformRotate.md
@@ -2,15 +2,15 @@ import TransRotateDemo from './transformRotate.demo.tsx'
 
 [Check options and parameters of transformRotate method](https://image-js.github.io/image-js-typescript/classes/Image.html#transformRotate 'github.io link')
 
-`transformRotate` method rotates image anti-clockwise at any angle that user sets. It applies the same principle as [transform](./transform.md 'internal link on transform demo') method, but user only needs to pass a rotation angle as a parameter instead of the whole matrix.
+transformRotate method rotates image anti-clockwise at any angle that user sets. It applies the same principle as [transform](./transform.md 'internal link on transform demo') method, but user only needs to pass a rotation angle as a parameter instead of the whole matrix.
 
 <TransRotateDemo />
 
 ### Parameters and its default values
 
-- [angle](https://image-js.github.io/image-js-typescript/classes/Image.html#transformRotate)
+- `angle`
 
-- [options](https://image-js.github.io/image-js-typescript/interfaces/TransformRotateOptions.html)
+- `options`
 
 #### Options
 
diff --git a/docs/Features/Morphology/bottomHat.md b/docs/Features/Morphology/bottomHat.md
@@ -2,7 +2,7 @@ import BottomHatDemo from './bottomHat.demo.tsx'
 
 [Check options and parameters of bottomHat method](https://image-js.github.io/image-js-typescript/classes/Image.html#bottomHat 'github.io link')
 
-Similarly to [topHat](./topHat.md 'internal link to top hat'), [bottom hat](https://en.wikipedia.org/wiki/Top-hat_transform 'wikipedia link to top hat') operation computes the difference between two images. However, if top hat was using [opening method](./open.md 'internal link on open method'), bottom hat is using [closing method](./close.md 'internal link on close method').
+Similarly to [topHat](./topHat.md 'internal link to top hat'), [bottomHat](https://en.wikipedia.org/wiki/Top-hat_transform 'wikipedia link to top hat') operation computes the difference between two images. However, if top hat was using [opening method](./open.md 'internal link on open method'), bottom hat is using [closing method](./close.md 'internal link on close method').
 The purpose of bottom hat(or, as it is also called, _black-hat_) is to enhance and extract **darker** regions of the image.
 
 <BottomHatDemo />
diff --git a/docs/Features/Morphology/cannyEdgeDetector.md b/docs/Features/Morphology/cannyEdgeDetector.md
@@ -3,7 +3,7 @@ import CannyEdgeDemo from './cannyEdgeDetector.demo.tsx'
 [Check options and parameters of cannyEdgeDetector method](https://image-js.github.io/image-js-typescript/classes/Image.html#cannyEdgeDetector 'github.io link')
 
 :::caution
-This method only works with images.
+This method works only with images.
 :::
 
 The Canny edge detector is a popular and widely used image processing technique for detecting edges in images. It is widely used in computer vision, image processing, and various applications such as object recognition, image segmentation, and feature extraction due to its ability to accurately detect edges and suppress noise.
diff --git a/docs/Features/Morphology/morphologicalGradient.md b/docs/Features/Morphology/morphologicalGradient.md
@@ -3,7 +3,7 @@ import MorphGradientDemo from './morphologicalGradient.demo.tsx'
 [Check options and parameters of morphologicalGradient method](https://image-js.github.io/image-js-typescript/classes/Image.html#morphologicalGradient 'github.io link')
 
 :::caution
-This method only works with images.
+This method works only with images.
 :::
 
 [The morphological gradient](https://en.wikipedia.org/wiki/Morphological_gradient 'wikipedia link on morphological gradient') is a mathematical operation used in image processing and mathematical morphology to highlight the boundaries of objects or regions within an image.
diff --git a/docs/Features/Morphology/topHat.md b/docs/Features/Morphology/topHat.md
@@ -2,7 +2,7 @@ import TopHatDemo from './topHat.demo.tsx'
 
 [Check options and parameters of topHat method](https://image-js.github.io/image-js-typescript/classes/Image.html#topHat 'github.io link')
 
-In morphology and image processing, [top hat](https://en.wikipedia.org/wiki/Top-hat_transform 'wikipedia link on top hat') is an operation used to enhance or extract small bright regions or details from an image while suppressing the larger surrounding structures.
+In morphology and image processing, [topHat](https://en.wikipedia.org/wiki/Top-hat_transform 'wikipedia link on top hat') is an operation used to enhance or extract small bright regions or details from an image while suppressing the larger surrounding structures.
 It is the result of subtraction between the result of input image [opening](./open.md 'internal link on open method') and the input image itself.
 The purpose of bottom hat(or as it is also called _black-hat_) is to enhance and extract **brighter** regions of the image.
 
