📚 Fix documentation spelling and grammar

Author: ronisbr

docs/src/man/html/html_backend.md

@@ -61,7 +61,7 @@ HtmlHighlighter(f::Function, fd::Function)
 ```
 
 The first will apply a fixed decoration to the highlighted cell specified in `decoration`,
-whereas the second let the user select the desired decoration by specifying the function
+whereas the second lets the user select the desired decoration by specifying the function
 `fd`.
 
 !!! note
@@ -75,8 +75,8 @@ whereas the second let the user select the desired decoration by specifying the
     **will not** affect the parameter `data` passed to the highlighter function `f`. It will
     always receive the original, unformatted value.
 
-For example, we if want to highlight the cells with value greater than 5 in red, and all the
-cells with value less than 5 in blue, we can define:
+For example, if we want to highlight the cells with values greater than 5 in red, and all
+the cells with values less than 5 in blue, we can define:
 
 ```julia
 hl_gt5 = HtmlHighlighter(
@@ -134,8 +134,7 @@ contains the following fields:
 Each field is a vector of [`HtmlPair`](@ref), *i.e.* `Pair{String, String}`, describing
 properties and values compatible with the HTML style attribute.
 
-For example, we if want that the stubhead label is bold and red, we must define:
-
+For example, if we want the stubhead label to be bold and red, we must define:
 ```julia
 style = HtmlTableStyle(
     stubhead_label = ["font-weight" => "bold", "color" => "red"]

docs/src/man/latex/latex_backend.md

@@ -51,8 +51,8 @@ where the user select the desired decoration by specifying the function `fd`.
     **will not** affect the parameter `data` passed to the highlighter function `f`. It will
     always receive the original, unformatted value.
 
-For example, we if want to make the cells with value greater than 5 in bold, and all the
-cells with value less than 5 to be small, we can define:
+For example, if we want to make the cells with value greater than 5 bold, and all the
+cells with value less than 5 small, we can define:
 
 ```julia
 hl_gt5 = LatexHighlighter(
@@ -91,7 +91,7 @@ contains the following fields:
 - `horizontal_line_before_summary_rows::Bool`: If `true`, a horizontal line will be drawn
     before the summary rows. Notice that this line is the same as the one drawn if
     `horizontal_line_after_data_rows` is `true`. However, in this case, the line is omitted
-    if there is no summary rows.
+    if there are no summary rows.
 - `horizontal_line_after_summary_rows::Bool`: If `true`, a horizontal line will be drawn
     after the summary rows.
 - `vertical_line_at_beginning::Bool`: If `true`, a vertical line will be drawn at the

docs/src/man/quick_start.md

@@ -8,7 +8,7 @@ CurrentModule = PrettyTables
 using PrettyTables
 ```
 
-The following commands prints the table in `matrix` using the text backend with all the
+The following command prints the table in `matrix` using the text backend with all the
 available sections:
 
 ```julia-repl

docs/src/man/text/predefined_formats.md

@@ -8,7 +8,7 @@ CurrentModule = PrettyTables
 using PrettyTables
 ```
 
-The text backend has some predefined borders and formats to print the tables.
+The text backend has some predefined borders and formats to print tables.
 
 ```@setup text_backend_predefined_formats
 data = Any[
@@ -105,7 +105,7 @@ pretty_table(
 
 ## Formats
 
-The text backend also defined some pre-defined formats to print the tables that can be used
+The text backend also defines some pre-defined formats to print tables that can be used
 through the keyword `table_format` in [`pretty_table`](@ref).
 
 `text_table_format__matrix`

docs/src/man/text/text_backend.md

@@ -12,9 +12,9 @@ the output.
     anchor. Otherwise, the end of the line will be aligned with the anchor.
   (**Default** = `:l`)
 - `alignment_anchor_regex::Union{Vector{Regex}, Vector{Pair{Int, Vector{Regex}}}}`: This
-  keyword can be used to provide regexes to aligh the data values in the table columns. It
+  This keyword can be used to provide regexes to align the data values in the table columns. If
   it is `Vector{Regex}`, the regexes will be used to align all the columns. If it is
-  `Vector{Pair{Int, Vector{Regex}}}`, the `Int` element specify the column to which the
+  `Vector{Pair{Int, Vector{Regex}}}`, the `Int` element specifies the column to which the
   regexes in `Vector{Regex}` will be applied. The regex match is searched in the same order
   as the regexes appear on the vector. The regex matching is applied after the cell
   conversion to string, which includes the formatters. If no match is found for a specific
@@ -79,7 +79,7 @@ keyword. Each highlighter is an instance of the structure [`TextHighlighter`](@r
 contains three fields:
 
 - `f::Function`: Function with the signature `f(data, i, j)` in which should return `true`
-  if the element `(i, j)` in `data` must be highlighter, or `false` otherwise.
+  if the element `(i, j)` in `data` must be highlighted, or `false` otherwise.
 - `fd::Function`: Function with the signature `f(h, data, i, j)` in which `h` is the
   highlighter. This function must return the `Crayon` to be applied to the cell that must be
   highlighted.
@@ -131,7 +131,7 @@ where it will apply the `Crayon` returned by the function `fd` to the highlighte
     **will not** affect the parameter `data` passed to the highlighter function `f`. It will
     always receive the original, unformatted value.
 
-For example, we if want to highlight the cells with value greater than 5 in red, and all the
+  For example, if we want to highlight the cells with value greater than 5 in red, and all the
 cells with value less than 5 in blue, we can define:
 
 ```julia
@@ -140,7 +140,7 @@ hl_gt5 = TextHighlighter(
     crayon"red"
 )
 
-hl_lt5 = HtmlHighlighter(
+hl_lt5 = TextHighlighter(
     (data, i, j) -> data[i, j] < 5,
     crayon"blue"
 )
@@ -175,7 +175,7 @@ contains the following fields:
 - `horizontal_line_before_summary_rows::Bool`: If `true`, a horizontal line will be drawn
     before the summary rows. Notice that this line is the same as the one drawn if
     `horizontal_line_after_data_rows` is `true`. However, in this case, the line is omitted
-    if there is no summary rows.
+    if there are no summary rows.
 - `horizontal_line_after_summary_rows::Bool`: If `true`, a horizontal line will be drawn
   after the summary rows.
 - `vertical_line_at_beginning::Bool`: If `true`, a vertical line will be drawn at the
@@ -211,7 +211,7 @@ contains the following fields:
 - `subtitle::Crayon`: Crayon with the style for the subtitle.
 - `row_number_label::Crayon`: Crayon with the style for the row number label.
 - `row_number::Crayon`: Crayon with the style for the row numbers.
-- `stubhead_label::Crayon`:  Crayon with the style for the stubhead label.
+- `stubhead_label::Crayon`: Crayon with the style for the stubhead label.
 - `row_label::Crayon`: Crayon with the style for the row labels.
 - `row_group_label::Crayon`: Crayon with the style for the row group label.
 - `first_line_column_label::Crayon`: Crayon with the style for the first column label lines.
@@ -229,7 +229,7 @@ contains the following fields:
 
 Each field is a `Crayon` describing the style for the corresponding element in the table.
 
-For example, we if want that the stubhead label is bold and red, we must define:
+For example, if we want the stubhead label to be bold and red, we must define:
 
 ```julia
 style = TextTableStyle(

docs/src/man/usage.md

@@ -177,7 +177,7 @@ can be specified using a symbol: `:l` for left, `:c` for center, or `:r` for rig
 
 !!! warning
 
-    Some backends does not support all the alignment options. For example, it is impossible
+    Some backends do not support all the alignment options. For example, it is impossible
     to define cell-specific alignment in the markdown backend.
 
 ### Other Arguments
@@ -403,7 +403,7 @@ v = f2(v, i, j)
 v = f3(v, i, j)
 ```
 
-Thus, the user must be ensure that the type of `v` between the calls are compatible.
+Thus, the user must ensure that the type of `v` between the calls is compatible.
 
 PrettyTables.jl provides some predefined formatters for common tasks as described in the
 next section.

src/backends/html/documentation.jl

@@ -1,6 +1,6 @@
 ## Description #############################################################################
 #
-# Documentation the HTML backend.
+# Documentation for the HTML backend.
 #
 ############################################################################################
 
@@ -64,14 +64,14 @@ A HTML highlighter can be constructed using three helpers:
 ```julia
 HtmlHighlighter(f::Function, decoration::Vector{Pair{String, String}})
 
-HtmlHighlighter(f::Function, decorations::NTuple{N, Pair{String, String})
+HtmlHighlighter(f::Function, decorations::NTuple{N, Pair{String, String}})
 
 HtmlHighlighter(f::Function, fd::Function)
 ```
 
-The first will apply a fixed decoration to the highlighted cell specified in `decoration`,
-whereas the second let the user select the desired decoration by specifying the function
-`fd`.
+ The first will apply a fixed decoration to the highlighted cell specified in `decoration`,
+ the second allows specifying decorations as a `Tuple`, and the third lets the user select
+ the desired decoration by specifying the function `fd`.
 
 !!! note
 
@@ -84,8 +84,8 @@ whereas the second let the user select the desired decoration by specifying the
     **will not** affect the parameter `data` passed to the highlighter function `f`. It will
     always receive the original, unformatted value.
 
-For example, we if want to highlight the cells with value greater than 5 in red, and
-all the cells with value less than 5 in blue, we can define:
+For example, if we want to highlight the cells with value greater than 5 in red, and all
+cells with values less than 5 in blue, we can define:
 
 ```julia
 hl_gt5 = HtmlHighlighter(
@@ -141,7 +141,7 @@ contains the following fields:
 Each field is a vector of [`HtmlPair`](@ref), *i.e.* `Pair{String, String}`, describing
 properties and values compatible with the HTML style attribute.
 
-For example, we if want that the stubhead label is bold and red, we must define:
+For example, if we want the stubhead label to be bold and red, we must define:
 
 ```julia
 style = HtmlTableStyle(

src/backends/latex/documentation.jl

@@ -1,6 +1,6 @@
 ## Description #############################################################################
 #
-# Documentation the LaTeX backend.
+# Documentation for the LaTeX backend.
 #
 ############################################################################################
 
@@ -35,7 +35,7 @@ contains the following two public fields:
     highlighter. This function must return a `Vector{String}` with the LaTeX environments to
     be applied to the cell.
 
-A LaTeX highlighter can be constructured using two helpers:
+A LaTeX highlighter can be constructed using two helpers:
 
 ```julia
 LatexHighlighter(f::Function, envs::Vector{String})
@@ -61,8 +61,8 @@ where the user select the desired decoration by specifying the function `fd`.
     **will not** affect the parameter `data` passed to the highlighter function `f`. It will
     always receive the original, unformatted value.
 
-For example, we if want to make the cells with value greater than 5 in bold, and all the
-cells with value less than 5 to be small, we can define:
+For example, if we want to make the cells with value greater than 5 bold, and all the cells
+with value less than 5 small, we can define:
 
 ```julia
 hl_gt5 = LatexHighlighter(

src/backends/markdown/documentation.jl

@@ -62,8 +62,8 @@ MarkdownHighlighter(f::Function, decoration::MarkdownStyle)
 MarkdownHighlighter(f::Function, fd::Function)
 ```
 
-The first will apply a fixed decoration to the highlighted cell specified in `decoration`
-whereas the second let the user select the desired decoration by specifying the function
+whereas the second lets the user select the desired decoration by specifying the function
+`fd`.
 `fd`.
 
 !!! note
@@ -94,7 +94,7 @@ that contains the following fields:
 
 - `row_number_label::MarkdownStyle`: Style for the row number label.
 - `row_number::MarkdownStyle`: Style for the row number.
-- `stubhead_label::MarkdownStyle`: Style for the stubhead label.
+- `first_column_label::MarkdownStyle`: Style for the first line of the column labels.
 - `row_label::MarkdownStyle`: Style for the row label.
 - `row_group_label::MarkdownStyle`: Style for the row group label.
 - `first_column_label::MarkdownStyle`: Style for the first line of the  column

src/backends/text/documentation.jl

@@ -1,6 +1,6 @@
 ## Description #############################################################################
 #
-# Documentation the text backend.
+# Documentation for the text backend.
 #
 ############################################################################################
 
@@ -19,24 +19,24 @@ the output.
     anchor. Otherwise, the end of the line will be aligned with the anchor.
     (**Default** = `:l`)
 - `alignment_anchor_regex::Union{Vector{Regex}, Vector{Pair{Int, Vector{Regex}}}}`: This
-    keyword can be used to provide regexes to aligh the data values in the table columns. It
+    keyword can be used to provide regexes to align the data values in the table columns. If
     it is `Vector{Regex}`, the regexes will be used to align all the columns. If it is
-    `Vector{Pair{Int, Vector{Regex}}}`, the `Int` element specify the column to which the
+    `Vector{Pair{Int, Vector{Regex}}}`, the `Int` element specifies the column to which the
     regexes in `Vector{Regex}` will be applied. The regex match is searched in the same
     order as the regexes appear on the vector. The regex matching is applied after the cell
     conversion to string, which includes the formatters. If no match is found for a specific
-    line, the alignment of this line depends on the options `alignment_anchor_fallback`.
+    line, the alignment of this line depends on the option `alignment_anchor_fallback`.
     Example: `[2 => [r"\\."]]` aligns the decimal point of the cells in the second column.
     (**Default** = `Regex[]`)
 - `apply_alignment_regex_to_summary_rows::Bool`: If `true`, the alignment regexes in
     `alignment_anchor_regex` will also be applied to the summary rows.
     (**Default** = `false`)
-- `auto_wrap::Bool`: If `true`, the text will be wrapped on spaces to fit the column. Notice
+- `auto_wrap::Bool`: If `true`, the text will be wrapped on spaces to fit the column. Note
     that this function requires `linebreaks = true` and the column must have a fixed size
     (see `fixed_data_column_widths`).
     (**Default** = `false`)
 - `column_label_width_based_on_first_line_only::Bool`: If `true`, the column label width is
-    based on the first line of the column. Hence, if the other column labels have a text
+    based on the first line of the column. Hence, if the other column labels have text
     width larger than the computed column width, they will be cropped to fit.
     (**Default** = `false`)
 - `display_size::Tuple{Int, Int}`: A tuple of two integers that defines the display size
@@ -54,18 +54,18 @@ the output.
     (**Default** = `true`)
 - `fixed_data_column_widths::Union{Int, Vector{Int}}`: If it is a `Vector{Int}`, this vector
     specifies the width of each column. If it is a `Int`, this number will be used as the
-    width of all columns. If the width is equal or lower than 0, it will be automatically
+    width of all columns. If the width is equal to or lower than 0, it will be automatically
     computed to fit the large cell in the column.
     (**Default** = 0)
 - `highlighters::Vector{TextHighlighter}`: Highlighters to apply to the table. For more
     information, see the section **Text Highlighters** in the **Extended Help**.
 - `line_breaks::Bool`: If `true`, a new line character will break the line inside the cells.
     (**Default** = `false`)
 - `maximum_data_column_widths::Union{Int, Vector{Int}}`: If it is a `Vector{Int}`, this
-    vector specifies the maximum width of each column. If it is a `Int`, this number will be
-    used as the maximum width of all columns. If the maximum width is equal or lower than 0,
-    it will be ignored. Notice that the parameter `fixed_data_column_widths` has precedence
-    over this one.
+    vector specifies the maximum width of each column. If it is an `Int`, this number will
+    be used as the maximum width of all columns. If the maximum width is equal or lower than
+    0, it will be ignored. Notice that the parameter `fixed_data_column_widths` has
+    precedence over this one.
     (**Default** = 0)
 - `overwrite_display::Bool`: If `true`, the same number of lines in the printed table will
     be deleted from the output `io`. This can be used to update the table in the display
@@ -88,8 +88,8 @@ keyword. Each highlighter is an instance of the structure [`TextHighlighter`](@r
 contains three fields:
 
 - `f::Function`: Function with the signature `f(data, i, j)` in which should return `true`
-    if the element `(i, j)` in `data` must be highlighter, or `false` otherwise.
-- `fd::Function`: Function with the signature `f(h, data, i, j)` in which `h` is the
+    if the element `(i, j)` in `data` must be highlighted, or `false` otherwise.
+- `fd::Function`: Function with the signature `fd(h, data, i, j)` in which `h` is the
     highlighter. This function must return the `Crayon` to be applied to the cell that must
     be highlighted.
 - `crayon::Crayon`: The `Crayon` to be applied to the highlighted cell if the default `fd`
@@ -140,7 +140,7 @@ where it will apply the `Crayon` returned by the function `fd` to the highlighte
     **will not** affect the parameter `data` passed to the highlighter function `f`. It will
     always receive the original, unformatted value.
 
-For example, we if want to highlight the cells with value greater than 5 in red, and
+For example, if we want to highlight the cells with value greater than 5 in red, and
 all the cells with value less than 5 in blue, we can define:
 
 ```julia
@@ -149,7 +149,7 @@ hl_gt5 = TextHighlighter(
     crayon"red"
 )
 
-hl_lt5 = HtmlHighlighter(
+hl_lt5 = TextHighlighter(
     (data, i, j) -> data[i, j] < 5,
     crayon"blue"
 )