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

Dev #38

Merged
merged 30 commits into from
Sep 3, 2021
Merged

Dev #38

merged 30 commits into from
Sep 3, 2021

Conversation

granthutchings
Copy link
Collaborator

No description provided.

Copy link
Collaborator

@luiarthur luiarthur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, @granthutchings!

I left some comments and suggestions. If any of them are too annoying, feel free to ignore.

Since I'm not familiar with the source and I don't know what the changes actually do, the changes I suggested mainly concern readability.

If possible, lines should be restricted to no longer than 90 characters in length. (If you are using a text editor like vim or vscode, there are options to enforce that of hard-wrap long lines.)

Possible ways for breaking down long lines include storing long function arguments in a variable before using them as function arguments.

To enhance readability, you can also rewrite long lines or sequence of operations as functions. (Be mindful, though, of declaring functions in functions that are used in time-critical code.

For example, I noticed some long function arguments are passed to some plot functions. They should probably be defined prior to the plt.plot function for better readability. (Please double check to make sure I didn't mess up in the suggestions.)

Also, small commits which provide one (maybe two) new features are usually preferred. In the case of rewriting tests, that's probably unreasonable. But, something to keep in mind.

NOTE: you can click commit suggestion where applicable in this review. In other places, you can just commit your changes if you want to address any of the comments.

sepia/SepiaPlot.py Outdated Show resolved Hide resolved
sepia/SepiaPlot.py Outdated Show resolved Hide resolved
sepia/SepiaPlot.py Outdated Show resolved Hide resolved
sepia/SepiaPlot.py Outdated Show resolved Hide resolved
sepia/SepiaPlot.py Outdated Show resolved Hide resolved
sepia/SepiaPlot.py Outdated Show resolved Hide resolved
sepia/SepiaPlot.py Outdated Show resolved Hide resolved
test/test_Neddermeyer.py Outdated Show resolved Hide resolved
test/test_Neddermeyer.py Outdated Show resolved Hide resolved
@granthutchings
Copy link
Collaborator Author

Great work, @granthutchings!

I left some comments and suggestions. If any of them are too annoying, feel free to ignore.

Since I'm not familiar with the source and I don't know what the changes actually do, the changes I suggested mainly concern readability.

If possible, lines should be restricted to no longer than 90 characters in length. (If you are using a text editor like vim or vscode, there are options to enforce that of hard-wrap long lines.)

Possible ways for breaking down long lines include storing long function arguments in a variable before using them as function arguments.

To enhance readability, you can also rewrite long lines or sequence of operations as functions. (Be mindful, though, of declaring functions in functions that are used in time-critical code.

For example, I noticed some long function arguments are passed to some plot functions. They should probably be defined prior to the plt.plot function for better readability. (Please double check to make sure I didn't mess up in the suggestions.)

Also, small commits which provide one (maybe two) new features are usually preferred. In the case of rewriting tests, that's probably unreasonable. But, something to keep in mind.

NOTE: you can click commit suggestion where applicable in this review. In other places, you can just commit your changes if you want to address any of the comments.

Thanks @luiarthur, ill commit some revisions in the next couple of days.

@granthutchings
Copy link
Collaborator Author

@luiarthur revisions done in commits d11720f, d0992cd

Copy link
Collaborator

@luiarthur luiarthur left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent, @granthutchings!

I just made a few formatting suggestions. If they look correct, then you can hit commit suggestions.

I'm fine with merging this unless anyone else wanted to take a look.

cc: @jgattiker @natalieklein229

sepia/SepiaPlot.py Outdated Show resolved Hide resolved
sepia/SepiaPlot.py Outdated Show resolved Hide resolved
sepia/SepiaPlot.py Outdated Show resolved Hide resolved
sepia/SepiaPlot.py Outdated Show resolved Hide resolved
sepia/SepiaPlot.py Outdated Show resolved Hide resolved
sepia/SepiaPlot.py Outdated Show resolved Hide resolved
sepia/SepiaPlot.py Outdated Show resolved Hide resolved
test/test_Neddermeyer.py Outdated Show resolved Hide resolved
test/test_Neddermeyer.py Outdated Show resolved Hide resolved
test/test_Neddermeyer.py Outdated Show resolved Hide resolved
@natalieklein229
Copy link
Collaborator

natalieklein229 commented Aug 31, 2021 via email

granthutchings and others added 3 commits August 31, 2021 11:36
Co-authored-by: Arthur Lui <luiarthur@gmail.com>
Co-authored-by: Arthur Lui <luiarthur@gmail.com>
Co-authored-by: Arthur Lui <luiarthur@gmail.com>
granthutchings and others added 7 commits August 31, 2021 11:37
Co-authored-by: Arthur Lui <luiarthur@gmail.com>
Co-authored-by: Arthur Lui <luiarthur@gmail.com>
Co-authored-by: Arthur Lui <luiarthur@gmail.com>
Co-authored-by: Arthur Lui <luiarthur@gmail.com>
Co-authored-by: Arthur Lui <luiarthur@gmail.com>
Co-authored-by: Arthur Lui <luiarthur@gmail.com>
Co-authored-by: Arthur Lui <luiarthur@gmail.com>
Copy link
Collaborator

@natalieklein229 natalieklein229 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! I think the separation of tests and notebooks is great.

It looks like the documentation could probably use a little updating; I can try to look at that, or please feel free to take a stab at it by editing docs/*.rst files.

@luiarthur
Copy link
Collaborator

Great, I think this is ready to be merged.

@jgattiker, if you feel good about the changes, you approve the changes.

This PR has some merge conflicts, but I can resolve those and merge after.

Might need @granthutchings's help if I run into anything tricky.

Copy link
Collaborator

@jgattiker jgattiker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cool

@luiarthur
Copy link
Collaborator

I'll merge this in the morning.

@luiarthur luiarthur merged commit 69599b7 into master Sep 3, 2021
@luiarthur luiarthur deleted the dev branch September 3, 2021 19:32
@luiarthur
Copy link
Collaborator

Thanks @granthutchings for this PR. And thanks @natalieklein229 and @jgattiker for reviewing.

FYI, I've squash-merged dev into master, and deleted dev.

Let me know if you have any questions.

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

Successfully merging this pull request may close these issues.

4 participants