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

3098 Refining documentations for moving_camera_scene module #3972

Conversation

Jackyuanx
Copy link
Contributor

Overview: What does this pull request change?

This closes #3098 by referencing the moving_camera_scene module documentation, and adding an additional example provided by MrDiver

Motivation and Explanation: Why and how do your changes improve the library?

This closes #3098

Links to added or changed documentation pages

This affects MovingCameraScene and moving_camera_scene

Reviewer Checklist

  • The PR title is descriptive enough for the changelog, and the PR is labeled correctly
  • If applicable: newly added non-private functions and classes have a docstring including a short summary and a PARAMETERS section
  • If applicable: newly added functions and classes are tested

Copy link
Member

@JasonGrace2282 JasonGrace2282 left a comment

Choose a reason for hiding this comment

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

Overall looks good to me, one minor comment, and then I believe it's good to go.
Thanks for helping make Manim better ✨

Comment on lines 105 to 108
Note: Examples are included in the moving_camera_scene module
documentation, see below in the 'see also' section.
.. SEEALSO::

:mod:`.moving_camera_scene`
Copy link
Member

Choose a reason for hiding this comment

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

This renders incorrectly, we might need an extra line before and after the .. SEEALSO::

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, I have added the change

@Jackyuanx Jackyuanx changed the title 3080 Refining documentations for moving_camera_scene module 3098 Refining documentations for moving_camera_scene module Oct 23, 2024
@TahitiX
Copy link
Contributor

TahitiX commented Oct 24, 2024

Thank you! We have added extra line before and after .. SEEALSO::.
Is it okay now?

Copy link
Member

@JasonGrace2282 JasonGrace2282 left a comment

Choose a reason for hiding this comment

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

Thanks, it looks good to me! Thanks for adding this example.

@JasonGrace2282 JasonGrace2282 merged commit 327db11 into ManimCommunity:main Oct 24, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Adding new example to documentation of MovingCamera and MovingCameraScene
4 participants