Docs for contour levels argument is incorrect #12729
Labels
Documentation
Good first issue
Open a pull request against these issues if there are no active ones!
Milestone
Bug report
Bug summary
In 2.2.3 a sentence made it into the
contourf
docs saying for the levels ofcontourf(x,y,z,levels, ....)
The bold sentence is obviously wrong, as seen from the below image. E.g. the top right plot has
n=4
specified, but it produces 5 intervals and 4 contour lines. When specifyingn=5
, the same 5 intervals and 4 contour lines are produced.One may look at the generated levels as a function of the input argument,
This is because a
MaxNLocator
is used.The
MaxNLocator
docs sayI would deduce, that the
contourf
docstring should rather sayIf an int n, use m data intervals, where m <= n+1; i.e. draw m-1 contour lines.
However, using different data, one may even find
which might suggest that also the
MaxNLocator
docstring is wrong, and should really sayBut maybe other data would even produce
N+x
intervals?ToDo:
MaxNLocator
is capable of producing.MaxNLocator
docstringcontourf
docstring.The text was updated successfully, but these errors were encountered: