Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.
Sign up[REVIEW]: Native PDF Reader Library in Julia #1453
Comments
This comment has been minimized.
This comment has been minimized.
Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @jameshclrk, it looks like you're currently assigned as the reviewer for this paper 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:
|
This comment has been minimized.
This comment has been minimized.
|
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
I've begun my review. In general, I think the need is clear - this package is a utility for reading PDF files in Julia, which is clearly useful to some people. The paper is intelligible, although suffers from grammatical errors throughout that should be fixed (as does the documentation). An example of a particularly ungrammatical sentence is "Almost, all the functionality of PDF understanding is entirely written from scratch in Julia with only exception of usage of certain (de)compression codecs". I find the third paragraph ("The APIs are developed...") confusing. What is a "native script based language"? I also don't understand the meaning of the sentence "every well-developed native library out in the market need connectors". In "Their contribution can be viewed from the following link.", the URL of the link should be included in the paper - I don't think a JOSS paper should have embedded hyperlinks without the actual URL being visible in the document. The paper should reference other Julia packages for handling PDF documents and explain how this package differs. In particular, I believe At present, I don't think the documentation is sufficient. There are no examples or tutorials referenced in the readme or documentation. The only overview, the "API structure and design" section in The documentation, as far as I've been able to find, consists solely of a description of each of dozens of API method which has been autogenerated from the docstrings in the source code and is listed in alphabetical order. It is not reasonable to expect new users to read through that to get started, and I'm not personally willing to do so and so cannot personally test to see if this package is functional. The package did install, although I can't personally test its functionality since the documentation is too sparse for me to understand how to use it. Running the automated test ( In conclusion, I think major revisions to the documentation are needed, but if that can be accomplished, this software is a good fit for JOSS. |
This comment has been minimized.
This comment has been minimized.
@malmaud Thanks for your review. I will update the documentation to address your concerns around the documentation. On the failing of the test cases, I guess for some reason the build step did not run when you added the package. If you can run the following command:
Now, the test shall pass successfully. |
This comment has been minimized.
This comment has been minimized.
OK, I just installed and tested in a fresh Julia environment and the tests pass now. |
This comment has been minimized.
This comment has been minimized.
@sambitdash — it looks like there remain several comments from @malmaud that need to be addressed. What's your status? |
This comment has been minimized.
This comment has been minimized.
@labarba - I am going for a complete revamp of the documentation by the end of this month. Most of the suggested changes will be addressed as part of that. I will update when the task is accomplished. |
This comment has been minimized.
This comment has been minimized.
@alexhanna Please follow up by email with @jameshclrk to know when we might expect their review. |
This comment has been minimized.
This comment has been minimized.
@whedon remind @sambitdash in 3 weeks |
This comment has been minimized.
This comment has been minimized.
Reminder set for @sambitdash in 3 weeks |
This comment has been minimized.
This comment has been minimized.
@labarba Emailed @jameshclrk. |
This comment has been minimized.
This comment has been minimized.
@whedon commands |
This comment has been minimized.
This comment has been minimized.
Here are some things you can ask me to do:
|
This comment has been minimized.
This comment has been minimized.
@whedon generate pdf |
This comment has been minimized.
This comment has been minimized.
|
This comment has been minimized.
This comment has been minimized.
PDF failed to compile for issue #1453 with the following error: Error reading bibliography ./paper.bib (line 14, column 1): |
This comment has been minimized.
This comment has been minimized.
@whedon generate pdf |
This comment has been minimized.
This comment has been minimized.
|
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
@whedon generate pdf |
This comment has been minimized.
This comment has been minimized.
|
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Please review with the Version: v0.1.5 of the software. |
This comment has been minimized.
This comment has been minimized.
Thanks so much @malmaud. Can you confirm this by checking off the necessary boxes in your review? |
This comment has been minimized.
This comment has been minimized.
done |
This comment has been minimized.
This comment has been minimized.
Thanks @malmaud. |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Thank you for the invitation, but I am sorry, I have to decline, too many deadlines to meet. |
This comment has been minimized.
This comment has been minimized.
I am on holiday until the 28th of October, but can then review this.
…On Wed, 23 Oct 2019, 15:16 George Datseris, ***@***.***> wrote:
Thank you for the invitation, but I am sorry, I have to decline, too many
deadlines to meet.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#1453?email_source=notifications&email_token=AAAUHJEMGPBAIBINA2I4B7LQQBMFBA5CNFSM4HNVMTJ2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOECBSLMI#issuecomment-545465777>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAAUHJH3CQQZ5UWUIPSMS43QQBMFBANCNFSM4HNVMTJQ>
.
|
This comment has been minimized.
This comment has been minimized.
Hi @jarvist -- are you able to review this now? |
This comment has been minimized.
This comment has been minimized.
@whedon remove @jameshclrk as reviewer |
This comment has been minimized.
This comment has been minimized.
OK, @jameshclrk is no longer a reviewer |
This comment has been minimized.
This comment has been minimized.
Certainly! |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
OK, @jarvist is now a reviewer |
This comment has been minimized.
This comment has been minimized.
I've just been reviewing this software + paper, but I can't seem to edit the checkboxes (also, they are still allocated to James Clark. @alexhanna - is this something you can fix? Generally I'm happy with the package... it installs and tests run. I think the latest draft of the paper looks good. However, I still think the package README.md could be edited down to make it more clear, and make it easier for a user to understand what the functionality is, and to get started. Are there any other high level access functions than From the point of view of the Package/API (not having read the source code), the namespace is quite confusing: the package is |
This comment has been minimized.
This comment has been minimized.
Hrm, try now @jarvist? I changed the name on the issue, but I'm not sure if that does anything. |
This comment has been minimized.
This comment has been minimized.
Still no 'edit' option in the '...' drop down menu. |
This comment has been minimized.
This comment has been minimized.
You shouldn't need to edit it. You can click the checkboxes without editing. Does that work for you? |
This comment has been minimized.
This comment has been minimized.
No joy there either. (I think the GUI checkbox clicking is predicated by edit permissions.) |
This comment has been minimized.
This comment has been minimized.
Hi @jarvist, Thanks a lot for taking time to review the software and the paper. Also reporting the bug on the product.
All methods starting with
Moreover, the similar nomenclature is used by other established PDF libraries in the market. Hence, people who have used other PDF libraries may quickly understand the scope of the APIs.
This has been fixed. If you think this is a gating requirement for the paper, please let me know so that I can release a new version of the software. |
This comment has been minimized.
This comment has been minimized.
|
This comment has been minimized.
This comment has been minimized.
@arfon - can you help with the reviewer invitation here? |
This comment has been minimized.
This comment has been minimized.
@jarvist - you've been invited by GitHub as a collaborator on this repository - you just need to accept the invite at this URL: https://github.com/openjournals/joss-reviews/invitations |
whedon commentedMay 17, 2019
•
edited by alexhanna
Submitting author: @sambitdash (Sambit Kumar Dash)
Repository: https://github.com/sambitdash/PDFIO.jl
Version: v0.1.5
Editor: @alexhanna
Reviewers: @malmaud, @jarvist
Archive: Pending
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) by leaving comments 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
@jarvist & @malmaud, 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.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @alexhanna know.
Review checklist for @jarvist
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 @malmaud
Conflict of interest
Code of Conduct
General checks
Functionality
Documentation
Software paper
paper.md
file include a list of authors with their affiliations?