Comments in VMobject should be moved to documentation

[markromanmiller]

There are comments in the code here:

manim/manim/mobject/types/vectorized_mobject.py

Lines 53 to 76 in 63735d3

	stroke_width=DEFAULT_STROKE_WIDTH,
	# The purpose of background stroke is to have
	# something that won't overlap the fill, e.g.
	# For text against some textured background
	background_stroke_color=BLACK,
	background_stroke_opacity=1.0,
	background_stroke_width=0,
	# When a color c is set, there will be a second color
	# computed based on interpolating c to WHITE by with
	# sheen_factor, and the display will gradient to this
	# secondary color in the direction of sheen_direction.
	sheen_factor=0.0,
	sheen_direction=UL,
	# Indicates that it will not be displayed, but
	# that it should count in parent mobject's path
	close_new_points=False,
	pre_function_handle_to_anchor_scale_factor=0.01,
	make_smooth_after_applying_functions=False,
	background_image_file=None,
	shade_in_3d=False,
	# This is within a pixel
	# TODO, do we care about accounting for
	# varying zoom levels?
	tolerance_for_point_equality=1e-6,

of which some should be moved to documentation.

This came up in a discord help request about set_sheen - I had a conversation in Discord (https://discord.com/channels/581738731934056449/669259565941915723/824696707836674098) that was resolved with a proper understanding what sheen_direction does (because it's not clear)

[mohansaimandalapu]

Hi MrMallIronmaker

Can I take up this issue, this is my first open source issue, I couldn't completely comprehend the issue, can you please elucidate it a bit more. Thank you

[jsonvillanueva]

Hey @mohansaimandalapu, what @MrMallIronmaker is referring to are docstrings which are written between the function's/method's declaration and the implementation. Please refer to our contributing guidelines on providing documentation to the project. There's a section there on adding documentation but this first section to get setup for developing Manim is very necessary to follow.

Let me know if you have any further questions!

[Darylgolden]

Unassigned as it has been 3 months without activity.

[ycechungAI]

I would like to work on this issue. I am going over contribution guidelines and setting up this project.

[ycechungAI]

#2184

[ycechungAI]

https://ycechung-opensource.blogspot.com/2021/10/yet-another-successful-hacktoberfest.html
My blog on open source about this issue