OSOceanAcoustics / echoregions

Interfacing water column sonar data with annotations and labels
https://echoregions.readthedocs.io/
Apache License 2.0
6 stars 6 forks source link

Unify input arguments `region_id`, `region_ids`, `region` for `Regions2D` methods #134

Closed leewujung closed 9 months ago

leewujung commented 11 months ago

Currently the Regions2D methods take a variety of input argument names region_id, region_ids, region that are all the same thing, so the current name is super confusing.

Let's unify them to all be region_id, so that it is clear what it is and be consistent with the columns in the Regions2D.data dataframe.

Let's include this in the first release since it's a small change that will go a long way.

leewujung commented 9 months ago

This is addressed in #139 .