Skip to content

Rename CustomTeX example scenes to be more specific. #223

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

Merged
merged 1 commit into from
Jul 27, 2020
Merged

Rename CustomTeX example scenes to be more specific. #223

merged 1 commit into from
Jul 27, 2020

Conversation

Aathish04
Copy link
Member

List of Changes

  • Rename ExampleFileScene to TexTemplateFromCLI
  • Rename ExampleClassScene to InCodeTexTemplate
  • Remove comments and rewrite them as docstrings for corresponding Scenes.

Motivation

The "better" way of drawing the end users' attention to how to use the custom TexTemplate related functions was discussed in #199 , and the conversation stopped with @leotrs suggesting that the instructions should probably go in the documentation instead of as comments in the file.

For clarity, ExampleFileScene has been renamed to TexTemplateFromCLI and ExampleClassScene has been renamed to InCodeTexTemplate to better reflect what they demonstrate.

Testing Status

As this is only a name change in an example scene, it shouldn't really impact anything else.
The scenes themselves still work as intended.

Acknowledgement

Rewrite comments about proper way to render scenes as Docstrings for each scene.
@Aathish04 Aathish04 requested a review from leotrs July 27, 2020 07:53
@leotrs leotrs merged commit 28f4d98 into ManimCommunity:master Jul 27, 2020
@Aathish04 Aathish04 deleted the rename-custom-texamples branch July 27, 2020 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Need to re-implement custom LaTeX related methods for current config system.
2 participants