image-segmentation-keras icon indicating copy to clipboard operation
image-segmentation-keras copied to clipboard

Published 20 hours ago • verified publisher icon divamgupta

docstrings & type hinting

Open rola93 opened this issue 3 years ago • 2 comments

Hello

I'm starting to use this awesome library and noticed that several functions are not well documented, in particular, they do not provide doc strings.

In addition to this, type hinting is a close related awesome tool available in python 3.5 and newer.

My proposal is to include both of them. I can write a PR to tackle it, but will need some feedback from mantainers. for instance, is there any policy with respect to both docstrings and type hinting?

Hope to contribute soon!

Rodrigo

rola93 avatar May 25 '21 00:05 rola93

Hi,

Thanks, the PR will be appreciated. We don't have any policy with docstrings. But we want that package should work with Python 2 as well.

Thanks.

divamgupta avatar May 25 '21 00:05 divamgupta

Ok thanks for your answer, so Docstings yes, type hinting nope.

I will close this issue then, hope to make an appropriated PR soon!

EDIT I couldn't close the issue, feel free to do it

rola93 avatar May 25 '21 15:05 rola93