Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

a few doc changes (1)

Pg Bielaab7db0e9439
diff --git a/manim/mobject/mobject.py b/manim/mobject/mobject.py
index 6ec5777e5..52be20bed 100644
--- a/manim/mobject/mobject.py
+++ b/manim/mobject/mobject.py
@@ -1123,17 +1123,17 @@ class Mobject(Container):
# About z-index
def set_z_index(self, z_index_value):
- """Set mobject's z_index property to z_index_value
+ """Sets the mobject's :attr:`z_index` to the value specified in `z_index_value`.
Parameters
----------
z_index_value : Union[:class:`int`, :class:`float`]
- The value of z_index that needs to be set.
+ The new value of :attr:`z_index` set.
Returns
-------
:class:`Mobject`
- The mobject object after setting z_index
+ The Mobject itself, after :attr:`z_index` is set. (Returns `self`.)
"""
self.z_index = z_index_value
return self