Re: [Docutils-develop] Giving type annotations to docutils

[Guenter M. <mi...@us...>]

Dear Takeshi KOMIYA, dear Docutils developers,

On 2022-01-02, Komiya Takeshi wrote:
> Hi all,

> I noticed py2 and py36- support will be dropped in the next release.

Yes, I am currently working on this, ... soon in the repository.

> It helps to integrate type annotations in docutils-stub package into
> upstream.
> I believe it helps to develop third-party extensions (including Sphinx).
> Is there any chance to merge it into the docutils?

In my view, it would make sense to have annotations right in the "master".

This could also be used as an indicator for the public API: 

In the `Docutils Backwards Compatibility Policy`__, we could change the
clause about the "scope of the public API" to an "opt-in" scheme: only
function/class interfaces with annotations belong to the stable, public
API while not annotated function interfaces may be changed or removed in
future versions if this helps to improve or clean up the code base.

What do other Docutils developers/contributors/users think?

Thanks,

Günter


__ https://docutils.sourceforge.io/docs/dev/policies.html#backwards-compatibility-policy