-
-
Notifications
You must be signed in to change notification settings - Fork 41
[REVIEW]: Lepton #1005
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
Comments
Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @adammichaelwood, it looks like you're currently assigned as the reviewer for this paper 🎉. ⭐ Important ⭐ If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/joss-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:
For a list of things I can do to help you, just type:
|
|
👋 Gentle nudge - @tpetricek, @adammichaelwood, have you had a chance to start looking at this yet? |
Thanks for the nudge! I was at a conference last week, but will post my initial comments today or on Thursday. |
Sorry - I've been a bit swamped in all areas. |
[Better late than never! Below is my review. I was not able to tick all the boxes above, so the review explains what problems I had and what I think needs to be corrected. I opened one issue for Lepton tracking the most important question, i.e. how to actually compile it] The project is a literate programming package that allows users to write code in a classic literate programming style as proposed by Knuth. In case of Lepton, this means using LaTeX syntax with embedded chunks of code that can be combined together to define the program (this also means you can refer to a code block defined later in the file). Lepton is mostly an implementation of the original idea by Knuth, without adding much new (although the documentation is not very clear about that, so there might be new things I might have missed). However, that seems reasonable - a good implementation of the idea for OCaml would be a useful contribution. Lepton is "implemented in itself" and my understanding is that to build it, you first need to run an existing version (to bootstrap it) and to obtain OCaml code which you can then compile to actually compile Lepton. However, I was not able to do this from scratch (see issue slithiaote/lepton#2). I think the repository needs a Makefile of some sorts and clear instructions about how to bootstrap things (possibly for different OSes, if this cannot be universal). Not being able to bootstrap Lepton meant that I was not able to tick the following review boxes:
Out of the documentation required for JOSS, I think the following are missing or not clear:
|
@slithiaote let me know if/when you've addressed the relevant issues and are ready to move forward with this |
@yochannah I replied to the issue/report on Nov 7th. At least part of the problem seems to be Windows, which is not a supported platform. I have asked for more input, but @tpetricek did not reply and I am hesitant to ping. |
@slithiaote I missed the reply. Sorry. I just added a comment on the issue. That said, I think there are other issues (see my comment above) that need to be addressed before this can be accepted as a JOSS publication - there are a few things that the JOSS checklist requires that I think are not yet satisfied by lepton. [EDIT] Also, if Windows is not supported platform (not even through the Ubuntu bash), then I don't think I can review this contribution. |
@tpetricek Sorry, I missed the edit note. I can look for another reviewer - it took me a while to find people interested in literate programming - you don't have any suggestions of possible interested colleagues or communities to approach? |
@yochannah I'm happy to stay involved if the author is interested in supporting Windows, at least through the Ubuntu Bash shell - I don't see why that should be impossible and I think it would be a good thing for the project in general. No matter what the supported platforms are, I think the project should use some form of pre-generated OCaml source code for bootstrapping rather than a checked-in executable where nobody knows what the executable might be doing. I think making that change (and adding a makefile) would likely make this work on Windows anyway. That said, if the project can be accepted with a binary file in the repository, then it needs to be reviewed by someone who is able (and brave enough) to run it, so in that case, I won't be able to help. I sadly don't have any good alternative reviewer ideas. |
@tpetricek Lepton compiles on Windows, but is mostly unusable because it requires the Unix library and Unix tools. Your comment made me realize that Windows Subsystem for Linux can provide those, although I will not be able to test it myself. I have been working on a source-based distribution for the past few days. I should be able to update this week. @yochannah Have you tried the "reproducible research" community ? |
Okay - this is good - it sounds like we may be able to keep @tpetricek onboard if we can get this on Windows! 👍 I do think I generally agree about @tpetricek's comment re pre-generated OCaml source code. |
I just committed to Github and tagged v1.1 |
Hey all - just checking the status of this review. @tpetricek, has @slithiaote's update managed to resolve your issues? @adammichaelwood, do you think you might have a chance to complete your review soon? Thanks all!! |
Thanks for the ping. I'm still trying to get it to build. Just added a comment there: slithiaote/lepton#2 In addition to that, the project still does not satisfy some of the JOSS items from the check-list above, so adding those (assuming they are strictly required for acceptance) would be another good thing to do in the meantime (especially, tests, contributor guidelines) |
Quick note - the readme on this repo was updated recently! :) I've added some comments about build issues in slithiaote/lepton#2 |
Yes, I updated the readme recently, but I did not have the time to comment as well. As far as I understand, @tpetricek expects to find installation instructions in The project contains two test files: an embedded |
@slithiaote I think I generally do agree - clear getting started docs in the readme is important for all open source software. I've added some comments myself in slithiaote/lepton#2 as I also had trouble getting things to run. |
👋 @slithiaote — Have you been able to make progress on this submission in the past month? What's your status? |
Not much has evolved since my last reply to comments last month. I am unsure what the issue is. The software is written in OCaml using only the standard library, so compilation should be uneventful. I anticipate that bootstrapping may not work out-of-the-box on all systems, but I did not receive error outputs on that topic. |
👋 @adammichaelwood, @tpetricek - would y'all have a chance to revisit this soon & let us know where things are? Thanks!! |
@whedon commands |
Here are some things you can ask me to do:
|
/ooo today until april 1 |
PDF failed to compile for issue #1005 with the following error: E, [2019-10-18 20:18:05#375] ERROR -- : Failed to parse BibTeX on value "This" (NAME) ["@", "Comment"] |
@openjournals/dev @arfon ☝️ do you know what is going on here? |
Is it perhaps related to the comment in the first line of my bibtex file ? |
Yeah, any chance you could remove that line please @slithiaote? |
@slithiaote can you merge this PR slithiaote/lepton#5 to fix the above. Once you do that can you run |
I would like to keep the Bibtex comment because it makes it clear that users should not edit the bib file directly. I can remove Do I need to tag a new release on zenodo with tag |
That probably works. No new release is necessary. |
@whedon generate pdf |
|
@whedon accept |
|
|
Check final proof 👉 openjournals/joss-papers#1039 If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#1039, then you can now move forward with accepting the submission by compiling again with the flag
|
|
1 similar comment
|
@whedon accept deposit=true |
|
🐦🐦🐦 👉 Tweet for this paper 👈 🐦🐦🐦 |
🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨 Here's what you must now do:
Any issues? notify your editorial technical team... |
@openjournals/dev this DOI is not resolving yet |
Looks like the Crossref queue is backed up. It should register in the next few hours. |
@Kevin-Mattheus-Moerman @arfon looks good now! |
Congrats @slithiaote on your article's publication in JOSS—thanks for being patient over this long process. Many thanks to @tpetricek and @rljacobson for reviewing this submission! |
🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉 If you would like to include a link to your paper from your README use the following code snippets:
This is how it will look in your documentation: We need your help! Journal of Open Source Software 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:
|
Thanks to the editors and reviewers from JOSS for their dedication and perseverance. |
Submitting author: @slithiaote (Sébastien Li-Thiao-Té)
Repository: https://github.com/slithiaote/lepton
Version: v1.2
Editor: @kyleniemeyer
Reviewers: @tpetricek, @rljacobson
Archive: 10.5281/zenodo.3492221
Status
Status badge code:
Reviewers and authors:
Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)
Reviewer instructions & questions
@tpetricek & @rljacobson, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:
The reviewer guidelines are available here: https://joss.theoj.org/about#reviewer_guidelines. Any questions/concerns please let @yochannah know.
✨ Please try and complete your review in the next two weeks ✨
Review checklist for @tpetricek
Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
paper.md
file include a list of authors with their affiliations?Review checklist for @rljacobson
Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
paper.md
file include a list of authors with their affiliations?The text was updated successfully, but these errors were encountered: