Make sure that synSetAnnotations' documentation clearly explain that this method should only be used for update existing annotations

Description

None

Environment

None

Activity

Show:
Kenneth Daily
June 5, 2018, 11:25 PM

The confusion lies in differences between the legacy R client and the Python client. The legacy R client did not do a 'synStore' for you when using 'synSetAnnotations', while the Python client does. So you could set annotations locally on an entity that wasn't stored yet. 's original problem was legitimate but has changed in the new R client. It should still be documented and made clear the intention of the function.

Kimyen Truong
August 24, 2018, 9:26 PM
Kimyen Truong
February 7, 2019, 7:31 PM

, can you validate that this document indicates that synSetAnnotation is used to “update” annotations? https://r-docs.synapse.org/reference/synSetAnnotations.html

Kimyen Truong
March 1, 2019, 10:17 PM

I’m moving this ticket to v0.6 epic since there is another ticket where we clearly state that this function “replaces” existing annotations.

Ryan Luce
May 5, 2020, 5:04 PM

Resolved for lengthy time (at least six months), closing in bulk

Assignee

Kimyen Truong

Reporter

Ben Logsdon

Labels

Validator

Kelsey Montgomery

Development Area

None

Release Version History

None

Components

Sprint

None

Fix versions

Priority

Major
Configure