mdhaber / scipy

Scipy library main repository
http://scipy.org/scipylib/
BSD 3-Clause "New" or "Revised" License
1 stars 5 forks source link

Reorder sections #84

Closed mdhaber closed 2 years ago

mdhaber commented 2 years ago

In gh-83, @acolum wrote:

I would recommend switching the order of the "Performance" and "Statement of need" sections to make the latter first, but still have both immediately follow the "Summary" section.

Respectfully, unless changing the order improves something else, I would prefer to maintain it because the "Statement of Need" section was written to conclude the paper and its content necessarily overlaps somewhat with the summary. (Neither would be complete without this information.) But naturally, as an author, I may read the paper differently from others.

@mcavs I would appreciate your thoughts on these suggested changes, too.

acolum commented 2 years ago

@mdhaber It's fine to leave it the way it is.

I originally made this suggestion because in the JOSS Author and Reviewer Guides and in most papers I've seen published in JOSS, the "Statement of need" immediately followed the "Summary." However, in this situation where the "Statement of need" was written to conclude the paper with some of the same ideas presented in the "Summary," I think it's okay to leave the paper as it is.

mdhaber commented 2 years ago

Ah, I see. Well, I'll close this for now, but perhaps it will be reopened if this placement of the "Statement of Need" is a requirement. Thanks @acolum!