Added DocStrings for Camera type objects, and updated DocStrings for Scene type objects. #36
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Removed trailing whitespaces.
and BackgroundColoredVMobjectDisplayer
Some methods were not mentioned outside of their definitions, and have less detailed docstrings.
Added DocStrings for Camera type objects, and updated DocStrings for Scene type objects.
eulertour
reviewed
May 20, 2020
| def add_fixed_in_frame_mobjects(self, *mobjects): | ||
| """This method allows the mobject to have a fixed position, | ||
| even when the camera moves around. | ||
| E.G If it was passed through this method, at the top of the frame, it |
Member
There was a problem hiding this comment.
nit: e.g. should have a . after the g and the two letters needn't both be capitalized.
eulertour
approved these changes
May 20, 2020
yoshiask
approved these changes
May 21, 2020
PgBiel
reviewed
May 22, 2020
Member
PgBiel
left a comment
PgBiel
left a comment
There was a problem hiding this comment.
i decided to stop reviewing midway, plz guys next time wait for a pending review
I'll make another PR to fix all this
| Some important CONFIG values and local variables to note are: | ||
| self.background_image : str, optional |
Member
There was a problem hiding this comment.
Wrong format for attributes. (Note: with dataclasses we will be able to deal with this more appropriately.)
For now...
"""(...)
Attributes
----------
background_image : str, optional
The path to an image that should be the background image.
If not set, the background is filled with `self.background_color`
pixel_height : int
(Text here???)
"""| } | ||
|
|
||
| def __init__(self, background=None, **kwargs): | ||
| """Initialises the Camera. |
Member
There was a problem hiding this comment.
Init documentation goes into the class docstring, using "Parameters". (Just move the Parameters section to the class docstring.)
| Parameters | ||
| ---------- | ||
| new_height : int, float |
Member
There was a problem hiding this comment.
- Use Union[a, b] for multiple type possibilities.
- Use
:class:`int`, :class:`float`
| ---------- | ||
| new_height : int, float | ||
| The new height of the entire scene in pixels | ||
| new_width : int, float |
| Returns | ||
| ------- | ||
| int |
| Parameters | ||
| ---------- | ||
| pixel_array : np.array, list, tuple |
| ---------- | ||
| pixel_array : np.array, list, tuple | ||
| The pixel array to convert and then set as the camera's pixel array. | ||
| convert_from_floats : bool, optional |
| Parameters | ||
| ---------- | ||
| pixel_array : np.array, list, tuple |
| ---------- | ||
| pixel_array : np.array, list, tuple | ||
| The pixel array to set the background to. | ||
| convert_from_floats : bool, optional |
| Returns | ||
| ------- | ||
| Camera |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DocStrings for viable methods of Camera, MovingCamera, ThreeDCamera, MappingCamera and MultiCamera have been added.
Some methods were not mentioned outside of their definitions, and DocStrings for these could be made more detailed.
The previous DocStrings written for classes in manimlib/scene have been updated to follow the numpy documentation format.