Skip to content

Commit

Permalink
fix a few typos - test julia 1.10 (#363)
Browse files Browse the repository at this point in the history
  • Loading branch information
t-bltg authored Nov 7, 2023
1 parent bd10d07 commit 8a854fc
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 8 deletions.
7 changes: 6 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
version:
- '1.6' # latest LTS
- '1'
- 'nightly'
- '~1.10.0-0' # upcoming julia version, next `rc`
os: [ubuntu-latest]
arch: [x64]
include: # spare windows/macos CI credits
Expand All @@ -29,6 +29,11 @@ jobs:
- os: macOS-latest
version: '1'
arch: x64
- os: ubuntu-latest
version: 'nightly'
arch: x64
allow_failure: true # `nightly` often breaks

steps:
- uses: actions/checkout@v3
- uses: julia-actions/setup-julia@latest
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 remaining axes with `zscale=:aspect`.
To plot a slice in 3D, use an anonymous function which maps to a constant value: `zscale=z -> a_constant`:

```julia
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -732,7 +732,7 @@ The method `label!` is responsible for the setting all the textual decorations o
<details>
<summary></a><b>...</b></summary><br>

Run the folowing snippet to analyze invalidations:
Run the following snippet to analyze invalidations:
```julia
using SnoopCompileCore
Expand Down
6 changes: 3 additions & 3 deletions docs/gen_docs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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 remaining axes 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))
Expand Down

0 comments on commit 8a854fc

Please sign in to comment.