Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added docstrings for :class:~.ValueTracker #1246

Merged
merged 10 commits into from Apr 9, 2021
Merged

Added docstrings for :class:~.ValueTracker #1246

merged 10 commits into from Apr 9, 2021

Conversation

kolibril13
Copy link
Member

@kolibril13 kolibril13 commented Apr 4, 2021 •
edited by RickyC0626

Changelog / Overview

Added docs for ValueTracker and added the function isub, because there was already iadd

Motivation

Explanation for Changes

Testing Status

Further Comments

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 kolibril13 added the documentation Improvements or additions to documentation label Apr 4, 2021
@kolibril13
Copy link
Member Author

See here: https://manimce--1246.org.readthedocs.build/en/1246/reference/manim.mobject.value_tracker.ValueTracker.html?highlight=valuetracker#manim.mobject.value_tracker.ValueTracker

@jsonvillanueva jsonvillanueva changed the title DocStings for ValueTracker Added docstrings for :class:~.ValueTracker Apr 7, 2021
RickyC0626
RickyC0626 approved these changes Apr 9, 2021
View reviewed changes
Copy link
Contributor

@RickyC0626 RickyC0626 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 👍🏻

manim/mobject/value_tracker.py Outdated Show resolved Hide resolved
@RickyC0626 RickyC0626 merged commit 7621c6a into ManimCommunity:master Apr 9, 2021
naveen521kk
naveen521kk reviewed Apr 9, 2021
View reviewed changes
manim/mobject/value_tracker.py
self.set_value(self.get_value() + d_value)

def __iadd__(self, d_value):
"""adds `+=` syntax to increment the value of the ValueTracker"""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's rst, use double ` for code and not single.

RickyC0626 added a commit that referenced this pull request Apr 9, 2021
@RickyC0626
Add double backquotes for rst code samples
807b3e4 
Appends to (#1246)
@RickyC0626 RickyC0626 mentioned this pull request Apr 9, 2021
Merged
12 tasks
kolibril13 added a commit that referenced this pull request Apr 9, 2021
@RickyC0626 @kolibril13
Add double backquotes for rst code samples (#1298)
9a525a8 
Appends to (#1246)

Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
@kolibril13 kolibril13 deleted the docsting_valtracker branch April 20, 2021 07:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@behackl behackl behackl left review comments

@naveen521kk naveen521kk naveen521kk left review comments

@RickyC0626 RickyC0626 RickyC0626 approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@kolibril13 @behackl @RickyC0626 @naveen521kk