From 8ef6ce0c7fa33034335f9352f2d7a83f945c0b5d Mon Sep 17 00:00:00 2001 From: Giorgio Calderone Date: Tue, 31 Mar 2020 10:17:06 +0200 Subject: [PATCH] Docstrings updated --- docs/make.jl | 2 +- docs/src/advanced.md | 6 +++--- docs/src/basic.md | 2 +- docs/src/index.md | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/make.jl b/docs/make.jl index c84bb7a..13beb47 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -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" diff --git a/docs/src/advanced.md b/docs/src/advanced.md index 1654edf..181b38e 100644 --- a/docs/src/advanced.md +++ b/docs/src/advanced.md @@ -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 diff --git a/docs/src/basic.md b/docs/src/basic.md index 3a8135d..574f176 100644 --- a/docs/src/basic.md +++ b/docs/src/basic.md @@ -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. diff --git a/docs/src/index.md b/docs/src/index.md index 3809a9c..ea25918 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -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"] ```