From fbabf50f5abf892e6011aa6943942fbea473b440 Mon Sep 17 00:00:00 2001 From: Andy Nowacki Date: Tue, 24 Aug 2021 16:10:20 +0100 Subject: [PATCH] Remove mention of tuples from description of `levels` The `levels` keyword argument does not actually support values of type `NTuple{2,Integer}` despite the existing documentation, so remove the mention of this from `_arg_desc` and update the description of what `levels` means. --- src/arg_desc.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/arg_desc.jl b/src/arg_desc.jl index da250471..af85b46d 100644 --- a/src/arg_desc.jl +++ b/src/arg_desc.jl @@ -30,7 +30,7 @@ const _arg_desc = KW( :marker_z => "AbstractVector, Function `f(x,y,z) -> z_value`, or Function `f(x,y) -> z_value`, or nothing. z-values for each series data point, which correspond to the color to be used from a markercolor gradient.", :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, NTuple{2,Integer}, or AbstractVector. Levels or number of levels (or x-levels/y-levels) for a contour type.", + :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).", :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`).",