documentation

documentation copied to clipboard

From @Uran198 on March 8, 2016 18:25

Only in some files there is use of function annotations. It would be good to either use annotations everywhere or don't use them at all.

Copied from original issue: coala-analyzer/coala#1848

From @sils1297 on March 8, 2016 18:28

I think we should define some guidelines about when and when not to use them.

We need them for enforce signature and the bears, otherwise they're mostly useless except if the type isn't obvious from the name, not sure what's the best way to guide this On 8 Mar 2016 7:25 p.m., "Attila" [email protected] wrote:

Only in some files there is use of function annotations https://www.python.org/dev/peps/pep-3107/. It would be good to either use annotations everywhere or don't use them at all.

— Reply to this email directly or view it on GitHub https://github.com/coala-analyzer/coala/issues/1848.

From @Makman2 on March 8, 2016 22:1

That's the problem, if you don't do anything with them they are quite useless. Only @enforce_signature accesses them and Bear.get_metadata() to pass coafile settings down to the custom defined run() with your own signature. like @sils1297 says, we need to discuss what's best^^

From @sils1297 on March 21, 2016 20:44

Alright, we probably want some docs about annotations and the enforce_signature stuff, @Uran198 would that help you?

From @Uran198 on March 22, 2016 4:44

Yes, I think guidelines in docs and consistency of code with those guidelines would be enough.

I would like to work on this issue.