Fix use of spaces between characters and at ends of lines

[magsol]

There are many lines in the file that have trailing spaces (extra space characters at the end of a line), as well as spaces between characters that should be deleted (between an opening parenthesis ( and the argument of a function).

For example:

def func( arg1, arg2 ):

has extra spaces between the parentheses and the argument names. The correct version should be:

def func(arg1, arg2):

There should, however, be spaces between operators (such as +, -, *, /, =, and ,).

For example:

print('Analyzing component ',(m+1),'...')

is incorrect, as there are no spaces between the operator + and the operands, or any spaces after the commas. The correct version should be:

print('Analyzing component ', (m + 1), '...')

[MOJTABAFA]

@magsol Actually I tried to apply it in all code, but still in some small parts linter gives the warning, would you please check it and let me know why it's not yet fixed ? Thanks again for reviewing such useful points.

[magsol]

Unfortunately there are more fixes here.

• Lines 55-72: there should be spaces on either side of every = sign, e.g. type=float should be type = float.
• Same in line 85, 97-102, 108, 114, 124, 126, and 134-135. I may have missed some, so definitely double-check.
• There should always be a blank newline between the last line of one function and the definition of the next. In particular, line 46 is the last line of op_VCTl2diff but the very next line is the definition of op_getResidual; there should be a blank line in between these two (helps readability).
• Similarly, in the docstring for each function, there should be a blank newline between the one-line description and the header Parameters. This is present in op_VCTl2diff but not in op_selectTopR.
• There should also be a blank newline between the end of the list of Parameters and the Returns header in the docstring. All the functions are missing this.
• The number of dashes ---- underlining a header in the docstring should be exactly the same width as the word they underline; there are two many dashes under both Returns headers.
• The return statements for the functions enclose single arguments in parenthesis, e.g. return (idxs_n). Parentheses are not needed unless there are multiple return values; please remove them.
• The indexing operations on line 51 also contain extra brackets. You do not need double brackets around indices; for example, S[[i], [j]] can simply be S[i, j].

[MOJTABAFA]

Thanks for such valuable pieces of advice. I done it, but just for item 1, when I'm spacing before and after operations ( like type=float ----> type = float) the small boxes around those lines are appeared again in sublime. It seems that the linter again starts to give warning. Again I'm not sure about my IDE and maybe it's a bug in win version of Sublime text 3.

[magsol]

That may correspond to one of the error codes that should be ignored. I posted a ticket with the error codes you should add to the ignore list in the configuration for SublimeLinter. If it's still showing up, I'll double check in case I missed one.

iPhone'd

On Dec 4, 2015, at 15:22, MOJTABAFA notifications@github.com wrote:

Thanks for such valuable pieces of advice. I done it, but just for item 1, when I'm spacing before and after operations ( like type=float ----> type = float) the small boxes around those line are appeared again in sublime. It seems that the linter again starts to give warning. Again I'm not sure about my IDE and maybe it's a bug in win version of Sublime text 3.

— Reply to this email directly or view it on GitHub.

[magsol]

A couple more small fixes:

• Line 57: trailing space after def main(): that should be deleted.
• Line 85: spaces should be added on both sides of the * operator.

[MOJTABAFA]

Thanks and sorry about forgetting that two modifications . those are applied now !

[magsol]

Another few:

• Line 123: missing space on either side of = in np.copyto.
• Lines 133-134: missing space on either side of = in np.savetxt.

[MOJTABAFA]

It's applied , Thanks!

[magsol]

Small edits:

• Line 51, 95-97, and 100: no need for parenthesis on either side of single variables P, T, or R
• v_sparce is misspelled; should be v_sparse
• Line 53: missing a space after comma
• Line 53: trailing space at end of line

Larger edits:

• In op_getResidual, P and R are extraneous arguments that can be removed entirely. P is already the length of the vector v and can be accessed through v.shape[0], and R is the length of idxs_n and can be accessed through idxs_n.shape[0].
• As such, line 52 can be changed to v_sparse[idxs_n] = v[idxs_n].
• Line 51 should also use v.shape[0] as the length of the array.

[MOJTABAFA]

Thanks , the modifications have been applied on code.

[magsol]

A few more:

• Line 31: Should be a blank newline between "parameters" and the previous docstring.
• Missing a docstring for the parameter S in the op_getResidual function.
• Line 40: Trailing whitespace; blank newlines should not have any spaces.

[MOJTABAFA]

applied. thanks.

[magsol]

• Several blank lines with trailing whitespace: lines 9, 17, and 44. These should simply be newlines; delete the trailing spaces.
• Line 13: trailing whitespace at the end of the line.

[MOJTABAFA]

As I remember , previously you told me that between "parameters and previous line should be a space" ( 3 posts earlier in the current issue) so lines 9, 17 and 32 should be remained ?

[magsol]

They should be blank lines, yes. My point is that they should not have any trailing whitespace.

What I mean by that: somehow, on those three lines, you didn't type anything, but you did hit the spacebar a few times before hitting "enter". Thus, the line is blank (no text), but there are trailing spaces. These need to be deleted.

They should show up in your Sublime editor. It should look like this:

[magsol]

There should be blank lines, but there should NOT be trailing whitespace.

[MOJTABAFA]

Ok, Thanks got it now.