Hey everyone,

TLDR: I propose that we allow adding types anywhere in code if it is useful.

A few months ago, we moved towards annotating our public API with mypy 
annotations [0].

I think it has overall gone well and also helped us catch a few problems.

The initial thought was to use it only for the public API and what was needed 
to have mypy pass the checks.

One thing that I often end up doing for large refactors is adding types in 
other places, and removing them
before I make the MR, which I think is not an ideal workflow and could benefit 
others.
I would now propose that we move towards allowing adding types anywhere the 
author think it is useful,
this would also allow us to stop documenting the types in the docstrings and 
only leverage type hints.

I do not mean by that that we should require type hints, rather that we should 
accept them as long as they
are correct and not causing problems.

Any thoughts on this?

Ben

[0] https://mail.gnome.org/archives/buildstream-list/2019-June/msg00043.html

Reply via email to