Docstrings updated

This commit is contained in:
Giorgio Calderone 2020-03-31 10:17:06 +02:00
parent 0b359d65c1
commit 8ef6ce0c7f
4 changed files with 6 additions and 6 deletions

View File

@ -8,7 +8,7 @@ makedocs(sitename="Gnuplot.jl",
"Home" => "index.md",
"Installation" => "install.md",
"Basic usage" => "basic.md",
"Advanced techniques" => "advanced.md",
"Advanced usage" => "advanced.md",
"Tips" => "tips.md",
"Examples" => "examples.md",
"API" => "api.md"

View File

@ -1,4 +1,4 @@
# Advanced techniques
# Advanced usage
Here we will show a few advanced techniques for data visualization using **Gnuplot.jl**.
@ -26,12 +26,12 @@ and can be used as an argument to both `@gp` and `gsp`, e.g.:
x = range(-2pi, stop=2pi, length=100);
y = sin.(x)
name = "\$MyDataSet1"
@gp name=>(x, y) "plot $name w l lc rgb 'black'" "pl $name u 1:(-1.5*\$2) w l lc rgb 'red'"
@gp name=>(x, y) "plot $name w l lc rgb 'black'" "pl $name u 1:(1.5*\$2) w l lc rgb 'red'"
saveas("ex010") # hide
```
![](assets/ex010.png)
Both curves use the same input data, but the red curve has the second column (`\$2`, corresponding to the *y* value) is multiplied by a factor -1.5.
Both curves use the same input data, but the red curve has the second column (`\$2`, corresponding to the *y* value) multiplied by a factor 1.5.
A named dataset comes in hand also when using gnuplot to fit experimental data to a model, e.g.:
```@example abc

View File

@ -12,7 +12,7 @@ The most important symbols exported by the package are the [`@gp`](@ref) (for 2D
- the special symbol `:-`, whose meaning is to avoid starting a new plot (if given as first argument), or to avoid immediately running all commands to create the final plot (if given as last argument). Its purpose is to allow splitting one long statement into multiple (shorter) ones.
The above list shows all the fundamental concepts to follow the examples presented below. The [`@gp`](@ref) and [`@gsp`](@ref) macros also accepts further arguments, but their use will be discussed in [Advanced techniques](@ref).
The above list shows all the fundamental concepts to follow the examples presented below. The [`@gp`](@ref) and [`@gsp`](@ref) macros also accepts further arguments, but their use will be discussed in [Advanced usage](@ref).
[^1]: a previous knowledge of [gnuplot](http://gnuplot.sourceforge.net/documentation.html) usage is, nevertheless, required.

View File

@ -63,5 +63,5 @@ In this documentation:
## Table of Contents
```@contents
Pages = ["index.md", "install.md", "basic.md", "advanced.md", "examples.md", "api.md"]
Pages = ["index.md", "install.md", "basic.md", "advanced.md", "tips.md", "examples.md", "api.md"]
```