[REVIEW]: Manim Slides: A Python package for presenting Manim content anywhere about jose-reviews HOT 71 CLOSED

@xuanxu any chance you could take a quick look?

from jose-reviews.

Thank you as always to our fearless leader and EiC @labarba, both for shepherding the paper to its publication as she does so well, and for helping iron out some remaining wrinkles with the new editorial bot.

from jose-reviews.

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @behollister, @bryanwweber it looks like you're currently assigned to review this paper 🎉.

⚠️ JOSE reduced service mode ⚠️

Due to the challenges of the COVID-19 pandemic, JOSE is currently operating in a "reduced service mode".

⭐ Important ⭐

If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/jose-reviews) repository. As a reviewer, you're probably currently watching this repository which means for GitHub's default behaviour you will receive notifications (emails) for all reviews 😿

To fix this do the following two things:

1. Set yourself as 'Not watching' https://github.com/openjournals/jose-reviews:

2. You may also like to change your default settings for this watching repositories in your GitHub profile here: https://github.com/settings/notifications

For a list of things I can do to help you, just type:

@whedon commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@whedon generate pdf

from jose-reviews.

Wordcount for paper.md is 786

from jose-reviews.

Software report (experimental):

github.com/AlDanial/cloc v 1.88  T=0.06 s (839.1 files/s, 86285.5 lines/s)
-------------------------------------------------------------------------------
Language                     files          blank        comment           code
-------------------------------------------------------------------------------
Python                          16            659            293           2531
Markdown                        19            284              0            688
YAML                            13             60             57            469
HTML                             1             68              5            218
TOML                             1             11              0             81
TeX                              1              5              0             48
DOS Batch                        1              8              1             26
Bourne Shell                     1             10              0             11
make                             1              4              7              9
-------------------------------------------------------------------------------
SUM:                            54           1109            363           4081
-------------------------------------------------------------------------------


Statistical information for the repository 'db2d887a27b587ca985b537f' was
gathered on 2023/04/26.
The following historical commit information, by author, was found:

Author                     Commits    Insertions      Deletions    % of changes
Fairlight8                       2            50             10            0.84
Federico Galatolo               22           505             35            7.59
Jérome Eertmans                113          4623           1406           84.78
Linus Heck                       6            75             43            1.66
MikeGillotti                     1            15              4            0.27
Tomasz Dądela                    1            15            192            2.91
Wu Tingfeng                      1            53             34            1.22
Wucheng Zhang                    1             3              0            0.04
pre-commit-ci[bot]               4            24             22            0.65
yang-fighter                     1             1              1            0.03

Below are the number of rows from each author that have survived and are still
intact in the current revision:

Author                     Rows      Stability          Age       % in comments
Fairlight8                   48           96.0          0.7               10.42
Federico Galatolo            94           18.6          1.2                0.00
Jérome Eertmans            3273           70.8          4.5                5.16
Linus Heck                   16           21.3         22.0               12.50
MikeGillotti                 11           73.3          5.5                0.00
Tomasz Dądela                 9           60.0          4.3               33.33
Wu Tingfeng                  20           37.7          5.9               15.00
pre-commit-ci[bot]           11           45.8          5.5                0.00
yang-fighter                  1          100.0          3.2                0.00

from jose-reviews.

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- None

MISSING DOIs

- None

INVALID DOIs

- None

from jose-reviews.

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

from jose-reviews.

@jeertmans Thanks for the paper and the package! I've created several issues in the repository related to my review:

• jeertmans/manim-slides#168
• jeertmans/manim-slides#169
• jeertmans/manim-slides#170
• jeertmans/manim-slides#171
• jeertmans/manim-slides#172

Aside from those issues, the version that is tagged here for the paper is not the most current release. @magsol How should that version be updated? Thank you! I look forward to the responses.

from jose-reviews.

Thanks for your review @bryanwweber! Indeed, the package has evolved quite a bit since the pre-review process was started. Most importantly, I have added a feature that converts Manim Slides presentations into PowerPoint files, which is pretty convenient for presenting in conferences for example.

I did not want to update the paper prior to the first review, but I can’t surely update the paper so it matches the latest version of Manim Slides.

For the rest of your review, I will address the comments directly in the PRs.

from jose-reviews.

Hello @bryanwweber, I have opened a series of PRs to address each of your comments.
I hope they answer your concerns correctly, and I hope open to any new suggestion you might have :-)

Already, thank you for your time!

from jose-reviews.

@whedon set v4.12.0 as version

from jose-reviews.

OK. v4.12.0 is the version.

from jose-reviews.

@jeertmans Thank you! I've left one comment on one of the PRs and otherwise they look good!

from jose-reviews.

Thanks @bryanwweber! I've merged all the PRs and released the changes under v4.13.0, which also contains more debugging messages (explaining the bump in minor version).

Tell me if you need anything else to be done :-)

from jose-reviews.

@whedon set v4.13.0 as version

from jose-reviews.

OK. v4.13.0 is the version.

from jose-reviews.

@behollister 👋 Hey Brad, wanted to check in and see if you needed anything for the review, or what kind of timetable you're looking at. Thanks!

from jose-reviews.

👋 @behollister, please update us on how your review is going (this is an automated reminder).

from jose-reviews.

👋 @bryanwweber, please update us on how your review is going (this is an automated reminder).

from jose-reviews.

My review is complete, thanks!

from jose-reviews.

@jeertmans Wanted to keep you informed: we're looking to wrap up this review by early-to-mid next week. Sorry for the delay!

from jose-reviews.

No problem at all @magsol :)
Thanks for noticing me!

from jose-reviews.

@jeertmans @magsol added issue related to review

jeertmans/manim-slides#188

from jose-reviews.

@jeertmans @magsol added issue related to review jeertmans/manim-slides#193
@bryanwweber may have already verified but didn't see the resolution comment in the original issue:
#207

concerns - Tests: Are there automated tests or manual steps described so that the function of the software can be verified?

and,

Functionality: Have the functional claims of the software been confirmed?

from jose-reviews.

@jeertmans @magsol included additional issue related to review jeertmans/manim-slides#194

concerns - Installation instructions: Is there a clearly stated list of dependencies? (Ideally these should be handled with an automated package management solution.)

from jose-reviews.

@jeertmans Thank you for your recent clarifications. Yes, all of the issues I raised have been addressed.

from jose-reviews.

@behollister Excellent, thank you so much!

from jose-reviews.

@whedon generate pdf

from jose-reviews.

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

from jose-reviews.

@whedon check references

from jose-reviews.

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- None

MISSING DOIs

- None

INVALID DOIs

- None

from jose-reviews.

@jeertmans Hi, now that both reviewers have recommended acceptance, I'm now starting the final review and acceptance procedures. I noticed your latest version hasn't been updated in a couple weeks (4.13.1 was the last). Would you mind 1) updating the version tag and archive if needed, and 2) reporting the archive DOI? Once I have these pieces of information, I'll proceed (as the PDF looks good!).

from jose-reviews.

Hello @magsol, thanks for recalling about the DOI! There you are: https://zenodo.org/record/7971361.

Tell me if I need to do anything else :-)

from jose-reviews.

@whedon set 10.5281/zenodo.7971361 as archive

from jose-reviews.

OK. 10.5281/zenodo.7971361 is the archive.

from jose-reviews.

@whedon set v4.13.2 as version

from jose-reviews.

OK. v4.13.2 is the version.

from jose-reviews.

@whedon recommend-accept

from jose-reviews.

Attempting dry run of processing paper acceptance...

from jose-reviews.

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- None

MISSING DOIs

- None

INVALID DOIs

- None

from jose-reviews.

👋 @openjournals/jose-eics, this paper is ready to be accepted and published.

Check final proof 👉 openjournals/jose-papers#125

If the paper PDF and Crossref deposit XML look good in openjournals/jose-papers#125, then you can now move forward with accepting the submission by compiling again with the flag deposit=true e.g.

@whedon accept deposit=true

from jose-reviews.

@jeertmans Thanks so much! Everything looks good--just waiting on EiCs to accept your paper!

from jose-reviews.

Many thanks for review!

from jose-reviews.

Hi @openjournals/jose-eics, just wanted to ping you on this one being ready for publication.

from jose-reviews.

Hello @magsol, I don't think you mention worked here. Do you know why all publications are stalled on JOSE's papers repo?

from jose-reviews.

@jeertmans I don't know, that's a good question. I'm so sorry for the delay. Let me ping the editors directly and hopefully we'll get something moving here.

from jose-reviews.

Hi everybody! 👋 — It's me who's backlogged due to travel, keynote, more travel, and email overload 😬
Thank you for your patience.

For some reason, the archive does not show on the top of the issue...

But I see that @magsol ran the command to add it above.

I will try to add it again with our upgraded editorial bot...

from jose-reviews.

@editorialbot set 10.5281/zenodo.7971361 as archive

from jose-reviews.

Done! archive is now 10.5281/zenodo.7971361

from jose-reviews.

have a look at this tiny fix: labarba/manim-slides#1

from jose-reviews.

Thanks for your suggestion @labarba, this is fixed :-)

As the v4.15.0 was released, and the paper is still not published, maybe it would be possible to update the version to v4.15.0, and the Zenodo to 10.5281/zenodo.8215167?

from jose-reviews.

Ah. Do you have the GitHub Zenodo integration set up to update the archive automatically with each release? We do like to ask authors to edit the metadata of the archive so that the title and author list match the paper. (The auto-archives pull as authors all committers to the repo and use the repo name as title.) Could you do that change for the archive we will attach to the JOSE paper?

from jose-reviews.

@editorialbot set v4.15.0 as version

from jose-reviews.

Done! version is now v4.15.0

from jose-reviews.

@editorialbot set 10.5281/zenodo.8215167 as archive

from jose-reviews.

Done! archive is now 10.5281/zenodo.8215167

from jose-reviews.

Ah. Do you have the GitHub Zenodo integration set up to update the archive automatically with each release? We do like to ask authors to edit the metadata of the archive so that the title and author list match the paper. (The auto-archives pull as authors all committers to the repo and use the repo name as title.) Could you do that change for the archive we will attach to the JOSE paper?

Done! :-)

from jose-reviews.

Oops. Somewhere we missed something. The archive is now 10.5281/zenodo.8215167 and it doesn't show the paper title.

from jose-reviews.

Like so @labarba ?

from jose-reviews.

@editorialbot accept

from jose-reviews.

Doing it live! Attempting automated processing of paper acceptance...

from jose-reviews.

⚠️ Couldn't acccept/publish paper. An error happened. Could not deposit with Open Journals.

from jose-reviews.

@openjournals/dev 👋
This is our first time accepting a paper here at JOSE with the new editorial workflow and bot, and I'm afraid something has gone awry. Help!

from jose-reviews.

@labarba That's weird, even more because I received a ORCID notification asking me the permission to link to that paper... which links to 404 not found https://joss.theoj.org/papers/10.21105/jose.00206

Note: I don't think the @openjournals/dev tag works

from jose-reviews.

I think I've fixed the error, retrying acceptance...

from jose-reviews.

Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository.

If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file.

You can copy the contents for your CITATION.cff file here:

cff-version: "1.2.0"
authors:
- family-names: Eertmans
  given-names: Jérome
  orcid: "https://orcid.org/0000-0002-5579-5360"
doi: 10.5281/zenodo.8215167
message: If you use this software, please cite our article in the
  Journal of Open Source Software.
preferred-citation:
  authors:
  - family-names: Eertmans
    given-names: Jérome
    orcid: "https://orcid.org/0000-0002-5579-5360"
  date-published: 2023-08-08
  doi: 10.21105/jose.00206
  issn: 2577-3569
  issue: 66
  journal: Journal of Open Source Education
  publisher:
    name: Open Journals
  start: 206
  title: "Manim Slides: A Python package for presenting Manim content
    anywhere"
  type: article
  url: "https://jose.theoj.org/papers/10.21105/jose.00206"
  volume: 6
title: "Manim Slides: A Python package for presenting Manim content
  anywhere"

If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation.

Find more information on .cff files here and here.

from jose-reviews.

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSE! 🚨🚨🚨

Here's what you must now do:

0. Check final PDF and Crossref metadata that was deposited 👉 openjournals/jose-papers#129
1. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/10.21105/jose.00206
2. If everything looks good, then close this review issue.
3. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

from jose-reviews.

🌈 Paper updated!

New PDF and metadata files 👉 openjournals/jose-papers#130

from jose-reviews.

Congratulations, @jeertmans, your JOSE paper is published! 🎉

Huge thanks to. our Editor: @magsol and the Reviewers: @behollister, @bryanwweber — this is all possible thanks to your generous contributions 🙏

from jose-reviews.

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

If you would like to include a link to your paper from your README use the following code snippets:

Markdown:
[![DOI](https://jose.theoj.org/papers/10.21105/jose.00206/status.svg)](https://doi.org/10.21105/jose.00206)

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/jose.00206">
  <img src="https://jose.theoj.org/papers/10.21105/jose.00206/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: https://jose.theoj.org/papers/10.21105/jose.00206/status.svg
   :target: https://doi.org/10.21105/jose.00206

This is how it will look in your documentation:

We need your help!

The Journal of Open Source Education is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following:

• Volunteering to review for us sometime in the future. You can add your name to the reviewer list here: http://jose.theoj.org/reviewer-signup.html
• Making a small donation to support our running costs here: https://numfocus.org/donate-to-jose

from jose-reviews.

Many thanks to all :D

from jose-reviews.