manim icon indicating copy to clipboard operation
manim copied to clipboard

Added documentation to `three_dimensions`

Open alembcke opened this issue 3 years ago • 1 comments

Overview: What does this pull request change?

Add documentation to three_dimensions.

Motivation and Explanation: Why and how do your changes improve the library?

More thorough and complete documentation for three_dimensions.

Links to added or changed documentation pages

https://manimce--2915.org.readthedocs.build/en/2915/reference/manim.mobject.three_d.three_dimensions.html

Further Information and Comments

Sorry for the sloppy commit history.

Reviewer Checklist

  • [ ] The PR title is descriptive enough for the changelog, and the PR is labeled correctly
  • [ ] If applicable: newly added non-private functions and classes have a docstring including a short summary and a PARAMETERS section
  • [ ] If applicable: newly added functions and classes are tested

alembcke avatar Aug 06 '22 14:08 alembcke

The convention is that the "Parameters" section should be before the "Examples" section, but this wasn't followed on some of the docstrings. So I updated that with another commit.

alembcke avatar Aug 20 '22 13:08 alembcke