Skip to content

docs: prepare for 3.0.0rc1 #5679

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

Merged
merged 3 commits into from
May 21, 2025
Merged

Conversation

henryiii
Copy link
Collaborator

@henryiii henryiii commented May 21, 2025

Description

Prepare for 3.0.0rc1.


📚 Documentation preview 📚: https://pybind11--5679.org.readthedocs.build/

Signed-off-by: Henry Schreiner <[email protected]>
@henryiii henryiii requested a review from Copilot May 21, 2025 04:43
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR prepares the documentation for the upcoming 3.0.0rc1 release by updating the upgrade guide and the changelog.

  • Updated the upgrade guide in docs/upgrade.rst to add additional context about compatibility variable warnings.
  • Revised the changelog in docs/changelog.md to include the release candidate date, new features, and additional PR references.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/upgrade.rst Modified text to clarify behavior regarding compatibility mode warnings.
docs/changelog.md Updated release candidate details, reformatted some feature names, and added PR references.
Comments suppressed due to low confidence (1)

docs/changelog.md:35

  • There appears to be an inconsistency in branch naming between 'smart-holder' and 'smart_holder'. Please confirm the correct branch name and update accordingly.
- The `smart_holder` branch has been merged, enabling

Copy link
Collaborator

@rwgk rwgk left a comment

Choose a reason for hiding this comment

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

Thanks a lot @henryiii!

@Skylion007
Copy link
Collaborator

So we aren't doing the include refactor for this release?

@henryiii
Copy link
Collaborator Author

henryiii commented May 21, 2025

When is it going to be ready? We've been working toward release for the last couple of weeks, with a major push during PyCon. Do you think it could be done today? (Also, the hope is to remain in RC for about a week)

@Skylion007
Copy link
Collaborator

Skylion007 commented May 21, 2025

When is it going to be ready? We've been working toward release for the last couple of weeks, with a major push during PyCon. Do you think it could be done today? (Also, the hope is to remain in RC for about a week)

Was hoping to get it done on/after Friday

@Skylion007
Copy link
Collaborator

@cyyever Might have spare cycles to help, we just need to split std.h into multiple smaller headers so people can optionally only include a subset of them.

@henryiii
Copy link
Collaborator Author

Let's get RC1 out, then this can go in during the RC period; it shouldn't affect users but we could do a RC2 if we want to make sure it gets tested. I'll add a note that this is an approved RC addition.

@henryiii henryiii merged commit fc888f7 into pybind:master May 21, 2025
74 checks passed
@henryiii henryiii deleted the henryiii/docs/3rc1 branch May 21, 2025 18:14
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.

3 participants