Skip to content
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

Refactored docstrings in mod:.geometry #2569

Merged
merged 3 commits into from Feb 25, 2022
Merged

Refactored docstrings in mod:.geometry #2569

merged 3 commits into from Feb 25, 2022

Conversation

ad-chaos
Copy link
Collaborator

@ad-chaos ad-chaos commented Feb 24, 2022 •
edited by behackl

Overview: What does this pull request change?

Refactors docstrings to follow numpy format
Continuation of #2560

Links to added or changed documentation pages

https://manimce--2569.org.readthedocs.build/en/2569/reference/manim.mobject.geometry.polygram.html
https://manimce--2569.org.readthedocs.build/en/2569/reference/manim.mobject.geometry.shape_matchers.html
https://manimce--2569.org.readthedocs.build/en/2569/reference/manim.mobject.geometry.tips.html

Further Information and Comments

Please merge this after #2560 as the docs build might fail and the fix for it has been made in that PR.

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

@ad-chaos ad-chaos changed the title Docstrings1 Refactored docstrings in mod:manim.mobject.geometry Feb 24, 2022
@behackl behackl added the documentation Improvements or additions to documentation label Feb 25, 2022
behackl
behackl approved these changes Feb 25, 2022
View reviewed changes
Copy link
Member

@behackl behackl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you.

@behackl behackl merged commit f5af1bb into ManimCommunity:main Feb 25, 2022
@behackl behackl changed the title Refactored docstrings in mod:manim.mobject.geometry Refactored docstrings in mod:.geometry Feb 25, 2022
@ad-chaos ad-chaos deleted the docstrings1 branch February 25, 2022 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@behackl behackl behackl approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@ad-chaos @behackl