Re: [Docutils-develop] Adding type hints directly to docutils?

[Stephen F. <st...@th...>]

On Tue, 2024-04-16 at 16:52 -0600, Dave Kuhlman wrote:
> On 2024-04-16 13:45, Guenter Milde via Docutils-develop wrote:
> > 
> > > I would be willing to tackle this effort if it would be welcomed (I
> > > previously tackled the "make docutils support Python 3 natively"
> > > effort, along with some smaller quality-of-life fixes).
> > 
> > Contributions are welcome.
> > 
> 
> I wrote the original code for rst2odt.
> I'm willing to work on that module.
> Any suggestions or guidance would be welcomed.
> 
> If we do attempt this task, it'd be good if we do
> it consistently across all the module we add type hints to.
> Is there something we should look at for a style guide?
> I can't find anything that is specific to type hints in
> PEP 8 (the style guide).  PEP 484 ("Type hints") has some
> guidance.  Is there anything else I should read?

That would be great. I would recommend checking out the docutils stub package in
the typedshed repo to see if hints are present there first. If not, you'd be
starting from scratch.

Regarding styling these, I'm not aware of anything as concrete as PEP 8 so I
think we'll be making it up as we go. I would suggest we mainly follow the style
of typeshed itself, in so far as there is a style. I would also like us to fold
the hints into the code itself, rather than presenting separate '.pyi' files.

Is there anything you've seen done elsewhere that you think we should duplicate
here?

Stephen

> 
> Dave
> 
> 
> _______________________________________________
> Docutils-develop mailing list
> Doc...@li...
> https://lists.sourceforge.net/lists/listinfo/docutils-develop
> 
> Please use "Reply All" to reply to the list.