Skip to content
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

[JOSS Review]: Quality of writing #5

Closed
jbytecode opened this issue Nov 18, 2020 · 4 comments
Closed

[JOSS Review]: Quality of writing #5

jbytecode opened this issue Nov 18, 2020 · 4 comments

Comments

@jbytecode
Copy link

Dear authors,

Due to the paper submission in JOSS:

There is a section called

Quality of writing: Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?

in the reviewing list.

First of all, I am sorry if I open too much issues, however, it is very convenient to talk each single item in a separate window.

The language of the paper is good. However expressions and statements are not well structured. Please consider using a single (and unique) rule when you present code snippets in the manuscript. I am suggesting the general rule (if you don't adopt your own):

  • Please remove space before a comma, put a space after a comma like 1, 2, 3, ..., n
  • Please put spaces before and after an operator like a = 5 and 2 + 2 = 4
  • Do not use spaces before and after a parenthesis in function calls

so the statement

n,d,d_nonzero,k,sigma =100,100,5,1,0.5

becomes

n, d, d_nonzero, k, sigma = 100, 100, 5, 1, 0.5

and the statement

(X,C,y),sol = random_data(n,d,d_nonzero,k,sigma,zerosum=True, seed = 123 )

becomes

(X, C, y), sol = random_data(n, d, d_nonzero, k, sigma, zerosum = True, seed = 123)

You can also consider saving space by refactoring

print("Relevant variables : {}".format(list(numpy.nonzero(sol)) ) )

to

print("Relevant variables: {}".format(list(numpy.nonzero(sol))))

Please check all the codes in the manuscript.

Thank you in advance.

@Leo-Simpson
Copy link
Owner

I think it is done now.

Best regards.

@jbytecode
Copy link
Author

Hi,

There is still uncorrected ones, please check all (for example)

  • A space before and after an operator

(X, C, y), sol = random_data(n, d, d_nonzero, k, sigma, zerosum=True, seed=123)

becomes

(X, C, y), sol = random_data(n, d, d_nonzero, k, sigma, zerosum = True, seed = 123)

and if it is too long, it could be divided into two lines properly.

Note: You can compile and preview the pdf file using this tool

@Leo-Simpson
Copy link
Owner

Hello,
Those spaces (for = in argument of a function) were not there because those was not taken into account by the package "black" I used to reformat. Now I have haded it in the code and in the examples !

So I think the syntax should be ok this time.

@jbytecode
Copy link
Author

seems okay. thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants