Skip to content

Conversation

@CAM-Gerlach
Copy link
Member

@CAM-GerlachCAM-Gerlach commented Oct 18, 2022

The final part of #95914 , and in turn part of #95913

Add links/references for each of the Summary items in the Python 3.11 What's New document where readers can find more information. Specifically:

  • For PEP-size items with their own sections, just reference the section directly and use its title as the link title, which is DRY/reduces duplication and also helps translators (per Doc: Remove title text from internal links #98409)
  • For the deprecation PEPs, link the entry for each from the summary description and elide the mostly redundant PEP titles (and for PEP 594, re-order the two bullets to put the main description first)
  • For ``PYTHONSAFEPATH`, link the entry and cross-reference the various entities (and make the summary a bit more concise)
  • For the tomllib addition, since the What's New entry contains essentially the same information of the summary, just use the appropriate Sphinx syntax to link the PEP, module and website directly

@bedevere-botbedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 18, 2022
@CAM-GerlachCAM-Gerlach changed the title Add links to more info in 3.11 WhatsNew Summary itemsgh-95914: Add links to 3.11 WhatsNew Summary itemsOct 18, 2022
@CAM-GerlachCAM-Gerlach added 3.11 only security fixes needs backport to 3.11 only security fixes labels Oct 18, 2022
@miss-islington
Copy link
Contributor

Thanks @CAM-Gerlach for the PR, and @ezio-melotti for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 18, 2022
) Add links to Summary items to where readers can learn more (cherry picked from commit fcae195) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@bedevere-bot
Copy link

GH-98420 is a backport of this pull request to the 3.11 branch.

@bedevere-botbedevere-bot removed the needs backport to 3.11 only security fixes label Oct 18, 2022
miss-islington added a commit that referenced this pull request Oct 18, 2022
Add links to Summary items to where readers can learn more (cherry picked from commit fcae195) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this pull request Oct 22, 2022
Add links to Summary items to where readers can learn more (cherry picked from commit fcae195) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3.11only security fixesdocsDocumentation in the Doc dirskip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@CAM-Gerlach@miss-islington@bedevere-bot@ezio-melotti