Skip to content

The various set_3d_properties() methods are undocumented. #18387

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.

Sign up for GitHub

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

Jump to bottom
Closed
QuocAnhVu opened this issue Sep 1, 2020 · 4 comments
Closed

The various set_3d_properties() methods are undocumented. #18387

QuocAnhVu opened this issue Sep 1, 2020 · 4 comments
Labels
Documentation topic: mplot3d

Comments

@QuocAnhVu
Copy link

Problem

I found the method used in this example here: https://matplotlib.org/gallery/animation/simple_3danim.html
And see various references throughout the API here: https://matplotlib.org/mpl_toolkits/mplot3d/api.html

But the example is opaque and the API documentation is blank.

Suggested Improvement

There should be a blurb explaining the purpose of the method and the semantic meaning of its arguments. There should be an example of a manipulation using the method.
@oscargus
Copy link
Member

Updating the link to documentation: https://matplotlib.org/stable/api/toolkits/mplot3d.html

@timhoffm
Copy link
Member

In #19572 I proposed to make these methods private.

@oscargus oscargus linked a pull request Aug 11, 2022 that will close this issue
add docstring for set_3d_properties for PatchCollection3d #19572
Closed
3 tasks
@github-actions
Copy link

This issue has been marked "inactive" because it has been 365 days since the last comment. If this issue is still present in recent Matplotlib releases, or the feature request is still wanted, please leave a comment and this label will be removed. If there are no updates in another 30 days, this issue will be automatically closed, but you are free to re-open or create a new issue if needed. We value issue reports, and this procedure is meant to help us resurface and prioritize issues that have not been addressed yet, not make them disappear. Thanks for your help!

@github-actions github-actions bot added the status: inactive Marked by the “Stale” Github Action label Aug 18, 2023
@github-actions github-actions bot added the status: closed as inactive Issues closed by the "Stale" Github Action. Please comment on any you think should still be open. label Sep 18, 2023
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Sep 18, 2023
@oscargus
Copy link
Member

Most (all?) of these are now documented.

@oscargus oscargus removed status: inactive Marked by the “Stale” Github Action status: closed as inactive Issues closed by the "Stale" Github Action. Please comment on any you think should still be open. labels Sep 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation topic: mplot3d
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

add docstring for set_3d_properties for PatchCollection3d ianhi/matplotlib
4 participants
@dopplershift @timhoffm @QuocAnhVu @oscargus