From ba13ab992624b654bc24205b35226037629d4b0e Mon Sep 17 00:00:00 2001 From: Thomas Breloff Date: Mon, 21 Sep 2015 16:59:15 -0400 Subject: [PATCH] readme --- README.md | 24 ++++++++++++------------ docs/example_generation.jl | 2 +- docs/readme_template.md | 22 +++++++++++----------- 3 files changed, 24 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 96acbdeb..25a3060b 100644 --- a/README.md +++ b/README.md @@ -107,17 +107,17 @@ the relevant column(s) and also automatically set the associated legend label. Here are some example usages... remember you can always use `plot!` to update an existing plot, and that, unless specified, you will update the `currentPlot()`. ```julia -plot() # empty plot object -plot(4) # initialize with 4 empty series -plot(rand(10)) # plot 1 series... x = 1:10 -plot(rand(10,5)) # plot 5 series... x = 1:10 -plot(rand(10), rand(10)) # plot 1 series -plot(rand(10,5), rand(10)) # plot 5 series... y is the same for all -plot(sin, rand(10)) # y = sin(x) -plot(rand(10), sin) # same... y = sin(x) -plot([sin,cos], 0:0.1:π) # plot 2 series, sin(x) and cos(x) -plot([sin,cos], 0, π) # plot sin and cos on the range [0, π] -plot(1:10, [rand(10), sin]) # plot 2 series, y = rand(10) for the first, y = sin(x) for the second... x = 1:10 for both +plot() # empty plot object +plot(4) # initialize with 4 empty series +plot(rand(10)) # plot 1 series... x = 1:10 +plot(rand(10,5)) # plot 5 series... x = 1:10 +plot(rand(10), rand(10)) # plot 1 series +plot(rand(10,5), rand(10)) # plot 5 series... y is the same for all +plot(sin, rand(10)) # y = sin(x) +plot(rand(10), sin) # same... y = sin(x) +plot([sin,cos], 0:0.1:π) # plot 2 series, sin(x) and cos(x) +plot([sin,cos], 0, π) # plot sin and cos on the range [0, π] +plot(1:10, Any[rand(10), sin]) # plot 2 series, y = rand(10) for the first, y = sin(x) for the second... x = 1:10 for both ``` With `subplot`, create multiple plots at once, with flexible layout options: @@ -158,7 +158,7 @@ ohlc!(args...; kw...) = plot!(args...; kw..., linetype = :ohlc) Some keyword arguments you can set: Keyword | Default Value | Aliases | Applies To --- | -- | -- | -- +---- | ---- | ---- | ---- args | Any[] | [:args,:argss] | Series axis | left | [:axis,:axiss] | Series color | auto | [:c,:color,:colors] | Series diff --git a/docs/example_generation.jl b/docs/example_generation.jl index 7ab8cce7..445ffc9f 100644 --- a/docs/example_generation.jl +++ b/docs/example_generation.jl @@ -218,7 +218,7 @@ function buildReadme() readme = readall("$DOCDIR/readme_template.md") # build keyword arg table - kwtable = "Keyword | Default Value | Aliases | Applies To\n-- | -- | -- | --\n" + kwtable = "Keyword | Default Value | Aliases | Applies To\n---- | ---- | ---- | ----\n" for d in (Plots._seriesDefaults, Plots._plotDefaults) for k in sort(collect(keys(d))) kwtable = string(kwtable, "$k | $(d[k]) | $(aliases(Plots._keyAliases, k)) | $(d==Plots._seriesDefaults ? "Series" : "Plot") \n") diff --git a/docs/readme_template.md b/docs/readme_template.md index 82574c48..73525734 100644 --- a/docs/readme_template.md +++ b/docs/readme_template.md @@ -107,17 +107,17 @@ the relevant column(s) and also automatically set the associated legend label. Here are some example usages... remember you can always use `plot!` to update an existing plot, and that, unless specified, you will update the `currentPlot()`. ```julia -plot() # empty plot object -plot(4) # initialize with 4 empty series -plot(rand(10)) # plot 1 series... x = 1:10 -plot(rand(10,5)) # plot 5 series... x = 1:10 -plot(rand(10), rand(10)) # plot 1 series -plot(rand(10,5), rand(10)) # plot 5 series... y is the same for all -plot(sin, rand(10)) # y = sin(x) -plot(rand(10), sin) # same... y = sin(x) -plot([sin,cos], 0:0.1:π) # plot 2 series, sin(x) and cos(x) -plot([sin,cos], 0, π) # plot sin and cos on the range [0, π] -plot(1:10, [rand(10), sin]) # plot 2 series, y = rand(10) for the first, y = sin(x) for the second... x = 1:10 for both +plot() # empty plot object +plot(4) # initialize with 4 empty series +plot(rand(10)) # plot 1 series... x = 1:10 +plot(rand(10,5)) # plot 5 series... x = 1:10 +plot(rand(10), rand(10)) # plot 1 series +plot(rand(10,5), rand(10)) # plot 5 series... y is the same for all +plot(sin, rand(10)) # y = sin(x) +plot(rand(10), sin) # same... y = sin(x) +plot([sin,cos], 0:0.1:π) # plot 2 series, sin(x) and cos(x) +plot([sin,cos], 0, π) # plot sin and cos on the range [0, π] +plot(1:10, Any[rand(10), sin]) # plot 2 series, y = rand(10) for the first, y = sin(x) for the second... x = 1:10 for both ``` With `subplot`, create multiple plots at once, with flexible layout options: