Skip to content

Add a section "Stub package versioning" - #10840

Merged
srittau merged 11 commits into
python:mainfrom
srittau:version-docs
Oct 8, 2023
Merged

srittau merged 11 commits into
python:mainfrom
srittau:version-docs

Conversation

@srittau

@srittau srittau commented Oct 5, 2023

Copy link
Copy Markdown
Collaborator

No description provided.

@srittau

srittau commented Oct 5, 2023

Copy link
Copy Markdown
Collaborator Author

Any suggestions welcome!

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

@AlexWaygood

AlexWaygood commented Oct 5, 2023 •

Copy link
Copy Markdown
Member

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

srittau commented Oct 5, 2023

Copy link
Copy Markdown
Collaborator Author

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
Copy Markdown
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 :/

@AlexWaygood AlexWaygood left a comment

Copy link
Copy Markdown
Member

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:

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
srittau

This comment was marked as off-topic.

srittau

This comment was marked as off-topic.

srittau

This comment was marked as off-topic.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated

@AlexWaygood AlexWaygood left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is great. Thanks!

Comment thread README.md Outdated
Co-authored-by: Alex Waygood <[email protected]>

@hauntsaninja hauntsaninja left a comment •

Copy link
Copy Markdown
Collaborator

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!

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
srittau and others added 2 commits October 7, 2023 21:45
@srittau
srittau merged commit a042be6 into python:main Oct 8, 2023
@srittau
srittau deleted the version-docs branch October 8, 2023 11:00
@srittau

srittau commented Oct 8, 2023

Copy link
Copy Markdown
Collaborator Author

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