alibi-detect icon indicating copy to clipboard operation
alibi-detect copied to clipboard

Types in return statements

Open mauicv opened this issue 1 year ago • 1 comments

As per our CONTRIBUTING.md we say:

Returning an object which contains multiple attributes and each attribute is described individually. In this case the attribute name is written between single back-ticks and the type, if provided, would be written in double back-ticks.

The language here makes it optional and we currently don't typically add types for return values that are contained in dicts, instead just opting to describe them. We should update this across the code base to be more specific. This would also mean updating the language here to make it clear that this isn't optional.

mauicv avatar May 18 '23 10:05 mauicv

Hi @mauicv I would like to take up this issue!

LakshmanKishore avatar Oct 21 '23 07:10 LakshmanKishore