Skip to content

New examples #576

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 31 commits into from
Oct 25, 2020
Merged

New examples #576

merged 31 commits into from
Oct 25, 2020

Conversation

MysaaJava
Copy link
Contributor

What to do

I wanted to use this draft to discuss the examples naming convention: There is currently three naming conventions:
ThingExample, ExampleThing and Thing.
For example, FadeInFadeOut, ExampleFadeInFadeOut and FadeInFadeOutExample.

List of Changes

Added kolibril's examples to the docs. I'm tweaking the code to remove all of the errors during documentation build (especially a bug where ffmpeg complains when using save_last_frame

Motivation

More examples to the docs .... always !

Testing Status

It works. but the documentation still has errors

Acknowledgement

@leotrs
Copy link
Contributor

leotrs commented Oct 20, 2020

If something is within the examples section, then it is redundant to add "Example" to the name. So I vote for "Thing". If totally necessary, I vote for "ThingEx", as a shorthand for "ThingExample".

@kolibril13 kolibril13 added the documentation Improvements or additions to documentation label Oct 21, 2020
@kolibril13
Copy link
Member

@MysaaJava Thanks a lot for putting this up so nicely!! 👍🏼

If something is within the examples section, then it is redundant to add "Example" to the name. So I vote for "Thing"

Yep, I also thing "Thing" would be the prettiest way.
However, sometimes it happened to me that a scene name was already taken by a manim internal class, which will result in errors.
To give an example, if we would name "DotExample" to "Dot", then we would get an error message.
Of course, we can just try to avoid these scenarios in avoiding these forbidden names, however, I feel not completely convinced by that.

I vote for "ThingEx", as a shorthand for "ThingExample".

I can agree on that

@kolibril13
Copy link
Member

Just left some comments

@kolibril13
Copy link
Member

Thank you for implementing these changes!
Can you click on resolve to the conversations above, so that we know that these changes are implemented?
From my side, I think this is ready to be merged as soon as we have all conversations resolved.
Deciding on how to rename the examples can then be done in a future pr.

@behackl
Copy link
Member

behackl commented Oct 22, 2020

I merged master to trigger the RTD build again. Something was weird with it.

@MysaaJava
Copy link
Contributor Author

I merged master to trigger the RTD build again. Something was weird with it.

It was just something about the logo link that changed (again)

Copy link
Member

@behackl behackl left a comment

Choose a reason for hiding this comment

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

Thank you so much for your work, this is great and improves the documentation by quite a bit again! 💯

I've added a bunch of mostly harmless suggestions (I think all of them concerning code formatting in the examples), please go over them and consider applying them.

And finally: Could you please explain why the changes in scene_file_writer.py were necessary? (This is not really something one would expect from a "more examples" kind of PR, and the file writing stuff is a bit delicate overall. In principle, I am okay with the changes and the tests also still pass, but I'd still like to hear a short explanation from you.)

@behackl
Copy link
Member

behackl commented Oct 22, 2020

Also, I am marking this as a PR thats no longer in draft status.

MysaaJava and others added 7 commits October 22, 2020 19:13
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Mostly reformatting in a more black-approved way

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Copy link
Contributor Author

@MysaaJava MysaaJava left a comment

Choose a reason for hiding this comment

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

The goal of scene_file_writer modifications was to remove ffmpeg complaining that the partial_movie_file.txt is empty

@behackl
Copy link
Member

behackl commented Oct 22, 2020

Thanks for explaining! Then I am also okay with the modifications to scene_file_writer.

…ternet conection nor on the filesystem changing.

Also applied some suggestions from beackl
@MysaaJava MysaaJava requested review from leotrs and behackl October 24, 2020 17:31
Copy link
Member

@behackl behackl left a comment

Choose a reason for hiding this comment

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

Thanks for your efforts! I think this is good to go now.

While looking through the examples you added one last time, I found #610 -- so don't worry if some videos are currently not looking right.

@kolibril13
Copy link
Member

kolibril13 commented Oct 24, 2020

Thanks a lot, I know this was a lot of work!
You are a patient and thorough developer, @MysaaJava :)

Copy link
Contributor

@leotrs leotrs left a comment

Choose a reason for hiding this comment

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

Sorry for the delay, and thanks for splitting the PRs.

@leotrs leotrs merged commit d586b11 into ManimCommunity:master Oct 25, 2020
@MysaaJava MysaaJava deleted the newExamples branch November 10, 2020 18:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants