-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Document filling of Poly3DCollection #16648
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
9f3ac12
to
af1eb5c
Compare
The calculation method for the z-order. | ||
See `~.Poly3DCollection.set_zsort` for details. | ||
*args, **kwargs | ||
All other parameters are forwarded to `.PolyCollection`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does .
mean at the beginning of a reference? Is this a sphinx thing, or something specific to matplotlib?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a "sphinx thing". But there is documentation on it in the matplotlib dev guide: https://matplotlib.org/devdocs/devel/documenting_mpl.html#referring-to-other-code
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to an incorrect visualization of the 3D area. | ||
|
||
If you need filled areas, it is recommended to create them via | ||
`~mpl_toolkits.mplot3d.axes3d.Axes3D.plot_trisurf`, which creates a |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would just write .Axes3D.plot_trisurf
(or ~.Axes3D.plot_trisurf
).
Can self-merge with or without that change.
…648-on-v3.2.x Backport PR #16648 on branch v3.2.x (Document filling of Poly3DCollection)
PR Summary
Closes #16633, by documenting the limitations and linking to
plot_trisurf
as a better way to create filled surfaces.