Rename CustomTeX example scenes to be more specific. #223
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
Rewrite comments about proper way to render scenes as Docstrings for each scene.
leotrs
approved these changes
Jul 27, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
List of Changes
ExampleFileScenetoTexTemplateFromCLIExampleClassScenetoInCodeTexTemplateMotivation
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,
ExampleFileScenehas been renamed toTexTemplateFromCLIandExampleClassScenehas been renamed toInCodeTexTemplateto 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