From e252404da17083aa5e6270b3204142bdc8cb29ef Mon Sep 17 00:00:00 2001 From: t-bltg Date: Tue, 7 Nov 2023 14:10:07 +0100 Subject: [PATCH] fix a few typos --- README.md | 8 ++++---- docs/gen_docs.jl | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 599310c0..b4d42975 100644 --- a/README.md +++ b/README.md @@ -365,7 +365,7 @@ Here is a list of the main high-level functions for common scenarios: Use `lines=true` to increase the density (underlying call to `lineplot` instead of `scatterplot`, with color interpolation). - By default, `surfaceplot` scales heights to adjust aspect the other axes with `zscale=:aspect`. + By default, `surfaceplot` scales heights to adjust aspect wrt the complementary axis with `zscale=:aspect`. To plot a slice in 3D, use an anonymous function which maps to a constant value: `zscale=z -> a_constant`: ```julia @@ -452,7 +452,7 @@ julia> Pkg.add("UnicodePlots") `UnicodePlots` is integrated in [`Plots`](https://github.com/JuliaPlots/Plots.jl) as a backend, with support for [basic layout](https://docs.juliaplots.org/stable/gallery/unicodeplots/generated/unicodeplots-ref17). - For a more complex layout, use the `gridplot` function (requires loading [`Term`](https://github.com/FedeClaudi/Term.jl)). + For a more complex layout, use the `gridplot` function (requires loading [`Term`](https://github.com/FedeClaudi/Term.jl) as extension). ```julia using UnicodePlots, Term @@ -687,7 +687,7 @@ The method `label!` is responsible for the setting all the textual decorations o These two canvas utilizes only standard `ASCII` character for drawing. Naturally, it doesn't look quite as nice as the Unicode-based ones. However, in some situations it might yield better results. Printing plots to a file is one of those situations. - **DensityCanvas**: - Unlike the `BrailleCanvas`, the density canvas does not simply mark a "pixel" as set. Instead it increments a counter per character that keeps track of the frequency of pixels drawn in that character. Together with a variable that keeps track of the maximum frequency, the canvas can thus draw the density of datapoints. + Unlike the `BrailleCanvas`, the density canvas does not simply mark a "pixel" as set. Instead it increments a counter per character that keeps track of the frequency of pixels drawn in that character. Together with a variable that keeps track of the maximum frequency, the canvas can thus draw the density of data-points. - **BarplotGraphics**: This graphics area is special in that it does not support any pixel manipulation. It is essentially the barplot without decorations but the numbers. It does only support one method `addrow!` which allows the user to add additional bars to the graphics object. @@ -732,7 +732,7 @@ The method `label!` is responsible for the setting all the textual decorations o
...
- Run the folowing snippet to analyze invalidations: + Run the following snippet to analyze invalidations: ```julia using SnoopCompileCore diff --git a/docs/gen_docs.jl b/docs/gen_docs.jl index cfcb7380..5c9e5ddd 100644 --- a/docs/gen_docs.jl +++ b/docs/gen_docs.jl @@ -251,7 +251,7 @@ The following types of `Canvas` are implemented: These two canvas utilizes only standard `ASCII` character for drawing. Naturally, it doesn't look quite as nice as the Unicode-based ones. However, in some situations it might yield better results. Printing plots to a file is one of those situations. - **DensityCanvas**: - Unlike the `BrailleCanvas`, the density canvas does not simply mark a "pixel" as set. Instead it increments a counter per character that keeps track of the frequency of pixels drawn in that character. Together with a variable that keeps track of the maximum frequency, the canvas can thus draw the density of datapoints. + Unlike the `BrailleCanvas`, the density canvas does not simply mark a "pixel" as set. Instead it increments a counter per character that keeps track of the frequency of pixels drawn in that character. Together with a variable that keeps track of the maximum frequency, the canvas can thus draw the density of data-points. - **BarplotGraphics**: This graphics area is special in that it does not support any pixel manipulation. It is essentially the barplot without decorations but the numbers. It does only support one method `addrow!` which allows the user to add additional bars to the graphics object. @@ -289,7 +289,7 @@ The following types of `Canvas` are implemented: """) invalidations = plain_md_par(""" - Run the folowing snippet to analyze invalidations: + Run the following snippet to analyze invalidations: ```julia using SnoopCompileCore @@ -536,7 +536,7 @@ $(indent(examples.imageplot1)) $(indent(examples.surfaceplot1)) Use `lines=true` to increase the density (underlying call to `lineplot` instead of `scatterplot`, with color interpolation). - By default, `surfaceplot` scales heights to adjust aspect the other axes with `zscale=:aspect`. + By default, `surfaceplot` scales heights to adjust aspect wrt the complementary axis with `zscale=:aspect`. To plot a slice in 3D, use an anonymous function which maps to a constant value: `zscale=z -> a_constant`: $(indent(examples.surfaceplot2))