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

add external_checksum and checksum_algorithm #365

Merged
merged 2 commits into from
Sep 16, 2019
Merged

Conversation

aaschaer
Copy link
Contributor

Adding these as explicit named arguments along with doc for how they are used by Transfer.

First PR since the linting and pytest changes, but I think make test did the right thing?

@sirosen
Copy link
Member

sirosen commented Aug 26, 2019

This looks good to me (and 👍 for documenting the parameters to add_item), but it looks like black is failing: https://travis-ci.com/globus/globus-sdk-python/jobs/228329637

This is sort of an issue with the way that I setup the tox.ini -- make test doesn't run black checking because I had issues getting tox -e lint to do what I wanted on Travis.
I have thoughts on ways of re-doing things, but it's just not been a priority.

If you run make autoformat it should fix any formatting issues. And I'd just amend with the result, since it's just a formatting fix.

Copy link
Member

@sirosen sirosen left a comment

Choose a reason for hiding this comment

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

I gave this a final check before merging and I noticed something suspicious about the spacing of the parameters as listed in the docstring. Passing it through sphinx (make docs) and looking at the resulting html, I can confirm that it doesn't come out quite right (or at least, not the same as our other docs).

We get this:
image
instead of
image

All that should be needed to tweak this is a little bit of indenting to make sphinx happy.
I've put the change that I believe makes this work here: 0986398
You can just git cherry-pick 0986398 if you want to pull in that change.

Minor tweaks to sphinx doc for TransferData.
@aaschaer
Copy link
Contributor Author

chery-picked the commit and the indenting seems fixed, thank you!

@sirosen sirosen merged commit f0b7b01 into master Sep 16, 2019
@sirosen sirosen deleted the external_checksum branch September 16, 2019 15:41
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.

2 participants