From 80eb749e814d376769ac0bb08a54cc3a181572ed Mon Sep 17 00:00:00 2001 From: Simon Christ Date: Thu, 5 May 2022 10:31:23 +0200 Subject: [PATCH] add Documentation --- src/arg_desc.jl | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/arg_desc.jl b/src/arg_desc.jl index 8d5b8adb..a6752a14 100644 --- a/src/arg_desc.jl +++ b/src/arg_desc.jl @@ -32,7 +32,8 @@ const _arg_desc = KW( :line_z => "AbstractVector, Function `f(x,y,z) -> z_value`, or Function `f(x,y) -> z_value`, or nothing. z-values for each series line segment, which correspond to the color to be used from a linecolor gradient. Note that for N points, only the first N-1 values are used (one per line-segment).", :fill_z => "Matrix{Float64} of the same size as z matrix, which specifies the color of the 3D surface; the default value is `nothing`.", :levels => "Integer (number of contours) or AbstractVector (contour values). Determines contour levels for a contour type.", - :orientation => "Symbol. Horizontal or vertical orientation for bar types. Values `:h`, `:hor`, `:horizontal` correspond to horizontal (sideways, anchored to y-axis), and `:v`, `:vert`, and `:vertical` correspond to vertical (the default).", + :permute => "Tuple{Symbol,Symbol}. Permutes data and axis properties of the axes given in the tuple. E.g. (:x, :y).", + :orientation => "Symbol. (deprecated) Horizontal or vertical orientation for bar types. Values `:h`, `:hor`, `:horizontal` correspond to horizontal (sideways, anchored to y-axis), and `:v`, `:vert`, and `:vertical` correspond to vertical (the default).", :bar_position => "Symbol. Choose from `:overlay` (default), `:stack`. (warning: May not be implemented fully)", :bar_width => "nothing or Number. Width of bars in data coordinates. When nothing, chooses based on x (or y when `orientation = :h`).", :bar_edges => "Bool. Align bars to edges (true), or centers (the default)?",