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

Add a section "Stub package versioning" #10840

Merged
merged 11 commits into from
Oct 8, 2023
Merged

Conversation

srittau
Copy link
Collaborator

@srittau srittau commented Oct 5, 2023

No description provided.

@srittau
Copy link
Collaborator Author

srittau commented Oct 5, 2023

Any suggestions welcome!

This will of course need an update if the discussion in #10837 concludes that we update our versioning scheme.

@AlexWaygood
Copy link
Member

AlexWaygood commented Oct 5, 2023

Could we also explicitly recommend against using mypy's --install-types option (and especially not --install-types --non-interactive)? The behaviour of --install-types #10825 (comment) is... quite bad.

I guess it's not ideal for us to single out a specific option for a specific type checker, but it is still the most widely used type checker.

@srittau
Copy link
Collaborator Author

srittau commented Oct 5, 2023

Isn't --install-types something that mypy should document better? Maybe even issue a warning when it's used? Otherwise, any wording suggestions welcome!

@AlexWaygood
Copy link
Member

Isn't --install-types something that mypy should document better? Maybe even issue a warning when it's used? Otherwise, any wording suggestions welcome!

Yes. It's unfortunately very widely used, however, so I think there'd be an outcry if mypy even tried to deprecate it :/

Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

Overall, this looks great! A few wording suggestions:

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
srittau and others added 2 commits October 5, 2023 14:06
srittau

This comment was marked as off-topic.

srittau

This comment was marked as off-topic.

srittau

This comment was marked as off-topic.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

This is great. Thanks!

README.md Outdated Show resolved Hide resolved
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Copy link
Collaborator

@hauntsaninja hauntsaninja left a comment

Choose a reason for hiding this comment

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

(A little late to this, so I haven't read the existing resolved comments)

Thank you for documenting this!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
srittau and others added 2 commits October 7, 2023 21:45
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
@srittau srittau merged commit a042be6 into python:main Oct 8, 2023
@srittau srittau deleted the version-docs branch October 8, 2023 11:00
@srittau
Copy link
Collaborator Author

srittau commented Oct 8, 2023

I think I integrated all comments, but I wouldn't be surprised if there's still a lot of fine-tuning possible in future PRs.

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.

4 participants