style: convert variables to lowercase #159
Conversation
john-halloran
changed the title
john-halloran
force-pushed
the
lowercasing
branch
from
7118dd2 to
a1560a4
Compare
There was a problem hiding this comment.
this is sooo much better. Please see my comments. Mostly on the docstrings, which are way more easily understood now.
When these things are fixed I am inclined to merge this, but we probably should revisit it. In general, we would prefer to write tests before we do the decsign and the functions, but this may not be a good strategy here. @john-halloran what are your thoughts on this.
src/diffpy/snmf/snmf_class.py
Outdated
| The data to be decomposed. Shape is (length_of_signal, number_of_conditions). | ||
| Y0 : ndarray | ||
| init_weights : ndarray |
There was a problem hiding this comment.
this should be init_weights : ndarray. Optional. Default = None
Though if the None gets processed to something else below then it is more informational to specify the default as what this thing gets processed to, if you see what I mean.
Please give the same treatment to all the optional variables.
There was a problem hiding this comment.
I want to ask for clarity on this one. "None" means the program will generate its own init_weights, but that is still ultimately an "ndarray". Should I still just write "Default = None"? To explain what it gets processed to, should that be inline there or in the docstring itself? If you can an example would be helpful.
There was a problem hiding this comment.
no, if None is processed to something else, put what the "something else" is as that is the defacto default. I just wanted to give a concrete example. In that case we are not putting the "type" of the default, but its actual value.
There was a problem hiding this comment.
here is an example
def func(thing=None):
''''thing : string Optional Default = "Sunny Morning"
The thing that describes outside
If thing is None:
thing = "Sunny Morning"
I think for understandability, it will be good to get this renaming out of the way asap, but otherwise I agree with all of this. Tests will be the next thing I work on and that will happen before any further development on the algorithms, to avoid our results drifting from the known-working state they are in currently. |
|
Everything should be renamed now, so if you see anything still capitalized, flag that in your review. Feel free to merge once all your feedback is addressed. Thanks for the help so far! |
src/diffpy/snmf/main.py
Outdated
| @@ -1,19 +1,19 @@ | |||
| import numpy as np | |||
| from snmf_class import SNMFOptimizer | |||
|
|
|||
| init_comps_file = np.loadtxt("input/X0.txt", dtype=float) | |||
| init_components_file = np.loadtxt("input/X0.txt", dtype=float) | |||
There was a problem hiding this comment.
hate to do this, but we probably need to rename all those files......
src/diffpy/snmf/snmf_class.py
Outdated
| The data to be decomposed. Shape is (length_of_signal, number_of_conditions). | ||
| Y0 : ndarray | ||
| init_weights : ndarray |
There was a problem hiding this comment.
no, if None is processed to something else, put what the "something else" is as that is the defacto default. I just wanted to give a concrete example. In that case we are not putting the "type" of the default, but its actual value.
src/diffpy/snmf/snmf_class.py
Outdated
| The data to be decomposed. Shape is (length_of_signal, number_of_conditions). | ||
| Y0 : ndarray | ||
| init_weights : ndarray |
There was a problem hiding this comment.
here is an example
def func(thing=None):
''''thing : string Optional Default = "Sunny Morning"
The thing that describes outside
If thing is None:
thing = "Sunny Morning"
|
Okay, that stuff should be in. Let me know if I had the right idea. |
This is a mostly complete conversion of variables to lowercase. Have tested to make sure behavior remains the same with before renaming. I'm still working on a few minor variables. The cleanup of old files is no longer included in this PR.