Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Annotations are used inconsistently #1848

Closed
Uran198 opened this issue Mar 8, 2016 · 5 comments
Closed

Annotations are used inconsistently #1848

Uran198 opened this issue Mar 8, 2016 · 5 comments

Comments

@Uran198
Copy link
Contributor

Uran198 commented Mar 8, 2016

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.

@sils
Copy link
Member

sils commented Mar 8, 2016

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" notifications@github.com 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
#1848.

@Makman2
Copy link
Member

Makman2 commented Mar 8, 2016

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^^

@sils
Copy link
Member

sils commented Mar 21, 2016

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

@Uran198
Copy link
Contributor Author

Uran198 commented Mar 22, 2016

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

@Adrianzatreanu
Copy link
Contributor

This issue was moved to coala/documentation#49

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

4 participants