Skip to content

Improve docstrings and variables name in mobject.py#4674

Open
GoThrones wants to merge 8 commits intoManimCommunity:mainfrom
GoThrones:improve_docstrings_and_variable_names_in_mobject
Open

Improve docstrings and variables name in mobject.py#4674
GoThrones wants to merge 8 commits intoManimCommunity:mainfrom
GoThrones:improve_docstrings_and_variable_names_in_mobject

Conversation

@GoThrones
Copy link
Copy Markdown
Contributor

@GoThrones GoThrones commented Apr 3, 2026

Overview: What does this pull request change?

This PR changes the docstrings at many places in mobject.py. At a few places, it improves the names of variables.

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

At some places the docstrings were not properly explained. At few places the docstrings were non-existent. Some of the variable names were not explicit. At one place, name of the method has been improved: Name of method set_z_index_by_z_Point3D has been improved to set_z_index_by_z_coordinate.

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

@GoThrones
Copy link
Copy Markdown
Contributor Author

GoThrones commented Apr 3, 2026

This CI failure appears to be an upstream TinyTeX URL issue, not related to this PR's changes.
I hope the admin/mods look into it, and make necessary changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant