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

Doc/whatsnew/3.{9,10,11}.rst are out of sync on various branches #100734

Open
zware opened this issue Jan 3, 2023 · 1 comment
Open

Doc/whatsnew/3.{9,10,11}.rst are out of sync on various branches #100734

zware opened this issue Jan 3, 2023 · 1 comment
Labels
3.10 3.11 3.12 docs Documentation in the Doc dir

Comments

@zware
Copy link
Member

zware commented Jan 3, 2023

Documentation

There are various inconsistencies between the whatsnew documents for 3.9, 3.10, and 3.11 on the 3.9, 3.10, 3.11, and main branches. Most of the inconsistencies are trivial, but some will require some research to determine which version is the canonical text that should be synced across branches.

@zware zware added docs Documentation in the Doc dir 3.11 3.10 3.12 labels Jan 3, 2023
@ned-deily
Copy link
Member

ned-deily commented Jan 3, 2023

This is an on-going problem due to the unnecessary duplication of data across release branches; it is also an issue with the generated changelog.html files for each branch. Rather than trying to patch over the problem again, we should fix it permanently by removing the duplication. One way that I believe would work is to change the whatsnew and changelog "templates" for each release branch to only contain the data for its branch and to include links at the bottom to the on-line version of the previous branch's whatsnew or changelog. There would also likely need to be some release manager actions added to PEP 101 and release scripts to delete the previous branch's whatsnew when creating a new release branch, i.e. at beta 1 time. One minor downside to this is that any off-line version of the docs would now have a link to the on-line whatsnew and changelog for previous releases rather than a fully self-contained off-line version but that's probably better than having incomplete and/or incorrect information as we do today. @python/python-release-managers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.10 3.11 3.12 docs Documentation in the Doc dir
Projects
None yet
Development

No branches or pull requests

3 participants
@ned-deily @zware and others