Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link from README to the release script #6458

Merged
merged 5 commits into from Dec 2, 2021
Merged

Link from README to the release script #6458

merged 5 commits into from Dec 2, 2021

Conversation

ewjoachim
Copy link
Contributor

@ewjoachim ewjoachim commented Nov 30, 2021

Also mention that packages are released daily

Also mention that packages are released daily
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Joachim Jablon and others added 2 commits Nov 30, 2021
Co-authored-by: Akuli <akuviljanen17@gmail.com>
JelleZijlstra added a commit to typeshed-internal/stub_uploader that referenced this issue Nov 30, 2021
It's every three hours, not daily.

Noticed by @ewjoachim in python/typeshed#6458.
@ewjoachim
Copy link
Contributor Author

@ewjoachim ewjoachim commented Nov 30, 2021

So logically from this comment, I would understand that this is not wanted. If that's so, I'm not in a position to do anything and we can close.

As a user of the said packages, though, I'm a little bit concerned by the idea the processes behind those packages would be "internal" and that making it hard to figure out where the release is being done is a feature and not a bug.

Of course, we could be in a situation where those packages are released manually and there would not be a way to audit how it's done. But given that there IS an open source script somewhere, I personally find some value in being able to find it on my own through documentation, and to study it.

With all that said, I'll let you decide how best you want to handle this :)

@JelleZijlstra
Copy link
Member

@JelleZijlstra JelleZijlstra commented Nov 30, 2021

I think it's fine to link from the typeshed README.

Copy link
Collaborator

@hauntsaninja hauntsaninja left a comment

--install-types doesn't actually look at PyPI and only works for a subset of typeshed packages. I recommend not mentioning it (e.g. see python/mypy#10619 , https://github.com/python/mypy/blob/master/mypy/stubinfo.py). It has some other quirks too, so I don't feel comfortable universally recommending it in typeshed (changes what versions of packages it installs over time, interactive by default, requires mypy cache and running mypy twice).

@ewjoachim
Copy link
Contributor Author

@ewjoachim ewjoachim commented Dec 1, 2021

I'd rather avoid back and forths on parts that are not my PR's subject :)

Can you @hauntsaninja and @Akuli give me a direction ? (asking because of #6458 (comment))

@JelleZijlstra
Copy link
Member

@JelleZijlstra JelleZijlstra commented Dec 1, 2021

I vote we just remove the part about --install-types. typeshed should aim to be type checker-agnostic anyway.

@ewjoachim
Copy link
Contributor Author

@ewjoachim ewjoachim commented Dec 1, 2021

Done :)

srittau
srittau approved these changes Dec 1, 2021
README.md Outdated
PyCharm, pytype etc. work in a similar way, for more details see documentation
for the type-checking tool you are using.
Copy link
Member

@JelleZijlstra JelleZijlstra Dec 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now this paragraph doesn't make sense, because it meant "similar to mypy". I would rewrite it as "Type checkers should be able to use these stub packages when installed. For more details, see the documentation for your type checker."

@ewjoachim
Copy link
Contributor Author

@ewjoachim ewjoachim commented Dec 2, 2021

Done :)

Maybe it might be worth it for someone who knows the project to make a full update of the documentation, fixing everything that needs to be fixed, but I suggest we do that on a different PR :)

@JelleZijlstra
Copy link
Member

@JelleZijlstra JelleZijlstra commented Dec 2, 2021

Yes, sorry for the back-and-forth here.

@JelleZijlstra JelleZijlstra merged commit ddcef53 into python:master Dec 2, 2021
54 checks passed
@ewjoachim ewjoachim deleted the patch-1 branch Dec 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants