MichaelSel / edoJS

A set of functions for manipulating musical pitches within a given EDO
GNU Affero General Public License v3.0
5 stars 0 forks source link

[Paper] Is this portion of the paper considered "documentation"? If so, remove #2

Closed napulen closed 3 years ago

napulen commented 3 years ago

This issue is related to the following review: https://github.com/openjournals/joss-reviews/issues/3784

Following the JOSS review criteria, the documentation mentions that

the paper should not include software documentation such as API (Application Programming Interface) functionality, as this should be outlined in the software documentation.

In the paper, there are two subsections that could potentially be considered software documentation:

I am generally okay with having these subsections in the paper, but asking @albincorreya and @bmcfee for their input.

bmcfee commented 3 years ago

I think the scope of what's currently included with the paper is in keeping with the spirit of the guidelines. Full documentation is overkill, but if describing the core abstractions is helpful to communicate what the library does, then that's fine.

napulen commented 3 years ago

I agree. I'm okay with closing this one.