downloadTableFile changed return type with no change in documentation or mention in release notes

Description

See https://github.com/Sage-Bionetworks/synapsePythonClient/issues/428.

The 'downloadTableFile' function seems to have changed return type (from a dict with a key 'path' to a string) and documentation is incorrect. The change resulted from issue SYNPY-403.

This was not listed as a change in the release notes for that issue "Use single endpoint for all downloads". We should improve our release procedure to identify a list of functions that have changed to help automate what we should write in the release notes?

Environment

None

Activity

Show:
Larsson Omberg
July 3, 2017, 6:36 PM

This was documented in the release notes under the removal of cachedir and files return values for downloads. We should have listed all affected functions however.

Kenneth Daily
July 3, 2017, 6:53 PM

Agreed - it's difficult to enumerate all of the potential effects. Is it just the docstring that is out of date?

Couldn't changing the return type of a function in the main client be considered a breaking change?

I'm guessing you mean this line in the release:

"Two member variables of the File object, file_entity.cacheDir and file_entity.files is [sic] being DEPRECATED in favor of file_entity.path for finding the location of a downloaded File."

That doesn't indicate to me that I should expect a return type to change, or that I would even be aware the 'downloadTableFile' is somehow affected by changes to the representation of a File entity.

Ziming Dong
August 11, 2017, 12:05 AM

per, Larsson, this function should be deprecated

Kenneth Daily
October 5, 2017, 4:42 AM

This was an issue filed in response to https://github.com/Sage-Bionetworks/synapsePythonClient/issues/428. Should follow up with user there to see if this resolves the issue.

Kenneth Daily
October 11, 2017, 4:27 PM

Fixed, will close corresponding issue on Github and let the issue creator know to reopen if there is still any problem.

Assignee

Ziming Dong

Reporter

Kenneth Daily

Labels

None

Validator

Kenneth Daily

Development Area

None

Release Version History

None

Fix versions

Priority

Major
Configure