MAINTENANCE: rename sum to sum_labels and add a deprecation warning #123

[tkoyama010]

MAINTENANCE: rename sum to sum_labels and add a deprecation warning #123

Join the big image sprint at SciPy Japan 2020 (#163)

[tkoyama010]

Thanks. It WFM. I will also add DeprecationWarning .

[GenevieveBuckley]

Ok, now we need asum function that will produce a deprecation warning and return the new sum_labels function instead.
Similar to this:

def sum(image, label_image=None, index=None):
   """Docstring goes here"""
    warnings.warn("Deprecation message goes here", DeprecationWarning)
    return sum_labels(image, label_image=label_image, index=index)

[tkoyama010]

[GenevieveBuckley]

Looks good to me! Excellent work @tkoyama010

[tkoyama010]

@GenevieveBuckley Thanks for great help ☺