search

openjournals / paper-JOSS-oneyear

Paper describing design and first-year of JOSS
Creative Commons Attribution 4.0 International
0 stars 0 forks source link

PeerJ R2C5 #12

Closed kyleniemeyer closed 6 years ago

kyleniemeyer commented 7 years ago

Section 1

Section 1 ends without giving a summary what the journal entails. It is described further. It is about publishing software, but it doesn’t say how far it goes in that (does it include the code, documentation, tests or is it just a description?). A summary is needed for the reader.

danielskatz commented 7 years ago

fair enough - we can and should do what is suggested.

kyleniemeyer commented 6 years ago

I added a new sentence to the last paragraph of Section 1:

The article describes the software from a high level, and wraps the software itself with any associated artifacts like tests, documentation, and examples.

arfon commented 6 years ago

The article describes the software from a high level, and wraps the software itself with any associated artifacts like tests, documentation, and examples.

'wraps' doesn't really parse very well for me. What about includes/encompasses/incorporates?

danielskatz commented 6 years ago

I was just going to say the same thing.

The article text doesn't actually do any of these - but the review process checks that they are part of the software being reviewed.

So, maybe:

The article describes the software from a high level, and the software itself includes both source code and associated artifacts such as tests, documentation, and examples.

danielskatz commented 6 years ago

sorry, looking at this again, I would prefer:

The article describes the software at a high level, and the software itself includes both source code and associated artifacts such as tests, documentation, and examples.

kyleniemeyer commented 6 years ago

sounds good