Fix bug and rename :meth:vector_coordinate_label to :meth:~.Vector.coordinate_label and move it to :class:geometry.py

[hydrobeam]

Changelog / Overview

Fix odd visuals and unnecessary functionality in vector_coordinate_label and move it to geometry.py as a method under Vector. Also includes compatibility for vector_space_scene

Motivation

BackgroundRectangle was raising some errors for vector_coordinate_label when animated with self.play(), so I removed its usages from this method since I couldn't find a reason for why it was there. Also, I removed the add_background_rectangles_to_entries=True from the method since it introduced some very odd looking labels.

Explanation for Changes

Usually, a label for a vector would be called by vector_coordinate_label and through passing a Vector mobject as the first argument (technically it could have been any Line). This makes the method explicitly attached to Vector and removes some useless functionality which causes errors and visual mishaps.

Old:

class A(Scene):
    def construct(self):
      vect = Vector([1,2])
      label = vector_coordinate_label(vect)
      self.add(vect, label)

New:

class A(Scene):
    def construct(self):
        vect = Vector([1, 2])
        label = vect.coordinate_label()
        self.add(vect, label)

Testing Status

Further Comments

The reason for the bug actually lies in BackgroundRectangle. This PR is simply intended to patch a rather useful method.

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

[behackl]

Overall this looks good to me, thanks for improving the implementation! I have one suggestion, please have a look and ping me once you have applied it (or want to discuss it).

I think that this PR fixes issues that the old implementation had, but at the same time it would be nice to have the option to have a background rectangle added -- maybe via an additional keyword parameter. It would also be a good first issue, could you simply open an issue for it and reference this PR?

[behackl]

I'd rather have the types as actual type hints. Also, I'm pretty sure that WHITE is just a str.

Suggested change

	def coordinate_label(self, integer_labels=True, n_dim=2, color=WHITE):
	"""A label based on the coordinates of the vector.
	Parameters
	----------
	integer_labels : :class:`bool`, optional
	Whether or not to round the coordinates to integers.
	n_dim : `class`:`int`, optional
	The number of dimensions of the vector.
	color : :class:`~.Colors`, optional
	The color of the label.
	def coordinate_label(self, integer_labels: bool = True, n_dim : int = 2, color: str = WHITE):
	"""A label based on the coordinates of the vector.
	Parameters
	----------
	integer_labels
	Whether or not to round the coordinates to integers.
	n_dim
	The number of dimensions of the vector.
	color
	The color of the label.

[hydrobeam]

I've implemented your suggestions, so it should be good to go! @behackl