Add docstring to explain get_collection method

DataBiosphere / data-store

AWS and GCP data storage system for genomic data.

https://dss.dev.ucsc-cgp-redwood.org

Other

3 stars 2 forks source link

Add docstring to explain get_collection method #139

Closed chmreid closed 4 years ago

chmreid commented 4 years ago

This addresses the discussion in PR #133 (https://github.com/DataBiosphere/data-store/pull/133/files#r386717524) by adding a docstring to explain why the get_collection() method returns the same information that the user provides to it. (Spoiler alert: it's because the method is only used to raise an exception if a given collection does not exist in the collection database.)

Hopefully this PR will put the discussion to rest!

DailyDreaming commented 4 years ago

Yep, it's just the call to the table to find out if that user owns that collection.