tk0miya / docutils-stubs

The Unlicense
9 stars 5 forks source link

Update to docutils 0.16 #33

Open domdfcoding opened 4 years ago

domdfcoding commented 4 years ago

Hi,

Would it be possible to have an updated release that supports docutils 0.16?

From what I can tell the changes from 0.14 to 0.16 are:

I dare say the current stubs will work with 0.16, but pip refuses to install them as the docutils requirement is pinned to 0.14 but one of my dependencies requires >=0.16 .

I'd be happy to submit a PR with these changes.

tk0miya commented 3 years ago

Contributions are always welcome :-)

gaborbernat commented 3 years ago

I think now we need to bump to https://pypi.org/project/docutils/0.17; though any reason why we hard pin the docutils version? Pythons gradual typing would mean we'd still be able to use it for newer versions, just the new parts would not be type annotated.

tk0miya commented 3 years ago

In addition, stub-only distributions SHOULD indicate which version(s) of the runtime package are supported by indicating the runtime distribution's version(s) through normal dependency data.

PEP-561 recommends to indicate the target version of the stub package. So we've pinned it. Is this wrong way?

gaborbernat commented 3 years ago

I think you want >= rather than == 🤔

Huy-Ngo commented 3 years ago

Maybe it's == because the stubs is supposed to cover all attributes/methods available? If that's the case then I'm not sure we can just jump from 0.14 to 0.16 and skipping 0.15.

McSinyx commented 3 years ago

I'm not sure we can just jump from 0.14 to 0.16 and skipping 0.15

We shouldn't, there should be a release to match each docutils release that we want to support. Note that the current CI doesn't perform integration with docutils' source.

@tk0miya, do you want some help maintaining these stubs? I know that you are working really actively on (and thus is busy with) Sphinx so you probably do not have much time and energy left for less important auxiliary packages like this one. I have quite some experience with Python static typing and I am working (with @Huy-Ngo) on a downstream repo where docutils-stubs is a common (and conflicting) dependency for many popular packages.

mborsetti commented 3 years ago

I think you want >= rather than == 🤔

Correct, as == does not scale as a single package that isn't updated can cascade a chain of non-upgradable packages.