Added Docstrings to :class:~.Mobject

[kolibril13]

As there are still a lot of undocumented functions, this pr will add some more docstings to mobject methods (e.g. rotate, get_x, flip, etc.
EDIT: SEE rendered page here: https://manimce--1206.org.readthedocs.build/en/1206/reference/manim.mobject.mobject.Mobject.html

Checklist

• I have read the Contributing Guidelines
• I have written a descriptive PR title (see top of PR template for examples)
• I have written a changelog entry for the PR or deem it unnecessary
• My new functions/classes either have a docstring or are private
• My new functions/classes have tests added and (optional) examples in the docs
• My new documentation builds, looks correctly formatted, and adds no additional build warnings

Reviewer Checklist

• The PR title is descriptive enough
• The PR is labeled correctly
• The changelog entry is completed if necessary
• Newly added functions/classes either have a docstring or are private
• Newly added functions/classes have tests added and (optional) examples in the docs
• Newly added documentation builds, looks correctly formatted, and adds no additional build warnings

[kolibril13]

I am just wondering:
https://docs.manim.community/en/latest/examples.html#rotationupdater
has a reference to add_updater()but it is not possible to click on it, however there is this page that gives an example how to use updater:
https://docs.manim.community/en/latest/reference/manim.mobject.mobject.Mobject.html#manim.mobject.mobject.Mobject.add_updater

[jsonvillanueva]

I figured out the issue, it's because our manim_directive.py has :ref_functions: link to :func:~.{func_here}... but the issue with this is that these aren't functions. They are methods. As such we need a :ref_methods: to link to :meth:~.{meth_here}

[kolibril13]

manim/docs/source/manim_directive.py

Line 135 in c3f6119

"ref_functions": lambda arg: process_name_list(arg, "func"),

Found it!
ok, I can add this to this pr.

[kolibril13]

Ready for review!

[jsonvillanueva]

Mostly small things. Periods at the ends of sentences, some references to :class:`~.Mobject`.

Also, some references to :meth:`~.Mobject.xxxxxxxx` should be used instead of ``xxxxxxxx``. Technically this documentation should have type hints as well as we've been enforcing that.

[kolibril13]

Thanks for the review!
Should there really be a reference to all mobjects?
I think is not really necessary, as this is the page of mobject.
Also, it is also not there in already existing docstrings of other methods in mobject:

However, if this is the better approach, I am fine with doing it that way.

[kolibril13]

As I am using type hints the first time, I am not sure if this is the best way to add them in this way Union["Mobject",np.ndarray, List], or if it is even possible to specify that the list/array needs to have exactly 3 entries.

[jsonvillanueva]

Thanks for the review!
Should there really be a reference to all mobjects?
I think is not really necessary, as this is the page of mobject.
Also, it is also not there in already existing docstrings of other methods in mobject:

However, if this is the better approach, I am fine with doing it that way.

This is more about completeness, but essentially these links will take the reader back to the top of the page that they're already on. Similarly, if you mention a method/function, they should also be linked to properly (even if they're on the same page) because the user can quickly jump to that section if they want to click on it and go to it.