Document table queries in get (command line client)

Description

The get function does not explain that get also works on Tables and Views (instead it states: downloads a file from Synapse).

If I run a synapse get -q synId on a file, the error message is not very informative either. (ValueError: Input query cannot be parsed. Please see our documentation for writing Synapse query: https://docs.synapse.org/rest/org/sagebionetworks/repo/web/controller/TableExamples.html)

In the Python documentation we call them tables explicitly.

I recommend we use consistent language across the clients and improve the documentation for this function in particular as it is required for downloading data from the portal. Vignette-like documentation for this function exists here.

Environment

None

Assignee

Jordan Kiang

Reporter

Kelsey Montgomery

Labels

None

Validator

Bruce Hoff

Development Area

None

Release Version History

None

Priority

Minor