AntiCompositeNumber created this task.
AntiCompositeNumber added a project: Pywikibot.
Restricted Application added subscribers: pywikibot-bugs-list, Aklapper.

TASK DESCRIPTION
  Pywikibot's docstrings currently include a lot of type information about the 
inputs and outputs of functions. However, this type information is not PEP 561 
<https://www.python.org/dev/peps/pep-0561/>-compatible and can't be read by 
static type checking tools like mypy.
  
  While inline type annotations would be ideal, they could cause compatibility 
issues with python 3.5 and below. Therefore, including separate type stub files 
makes the most sense as runtimes that don't need or understand them can ignore 
them.
  
  Stub files can be included in the same directory as the file they describe, 
or they can be included in a completely separate package. Using a separate 
package would increase maintenance overhead and require more work from users to 
use the type stubs, while keeping the type stubs in the same directory could 
increase clutter in modules. I think keeping them in the same directory is best 
to start with.
  
  https://mypy.readthedocs.io/en/stable/stubs.html

TASK DETAIL
  https://phabricator.wikimedia.org/T250711

WORKBOARD
  https://phabricator.wikimedia.org/project/board/87/

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: AntiCompositeNumber
Cc: Aklapper, AntiCompositeNumber, pywikibot-bugs-list, Zkhalido, Viztor, 
Wenyi, Tbscho, MayS, Mdupont, JJMC89, Dvorapa, Altostratus, Avicennasis, 
mys_721tx, jayvdb, Masti, Alchimista, Rxy
_______________________________________________
pywikibot-bugs mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/pywikibot-bugs

Reply via email to