Skip to content

Conversation

@JacobCoffee
Copy link
Member

@JacobCoffeeJacobCoffee commented Sep 26, 2023

  • Adds guidelines on what release cycles (where) should get backports of documentation and testing improvements.

Closes

Changes visualized:Dev. CycleVersions

📚 Documentation preview 📚: https://cpython-devguide--1169.org.readthedocs.build/

@AA-TurnerAA-Turner changed the title docs(#1168): add directive on when/where to backport docs and testing changesNote when to backport changesSep 26, 2023
Copy link
Member

@AA-TurnerAA-Turner left a comment

Choose a reason for hiding this comment

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

Thanks for this Jacob. I agree with Victor's comments, this needs a few edits in the first instance.

A tip for using admonitions: they stand out and are highlighted, which means that using them must be done sparingly -- when is is most critical for a reader to be aware of a point? I think in this instance, backporting is not of sufficient import; so regular prose is fine. This is very akin to the boy who cried wolf, just in this instance replace the villagers with readers and the wolf with admonitions!

A

@JacobCoffee
Copy link
MemberAuthor

Thanks Adam, and understood. That makes sense - the use of admonitions is quite a bit different than I am used to 😄

@JacobCoffee
Copy link
MemberAuthor

Please re-review at your earliest convenience to see if it is in line with what we want to communicate

@JacobCoffeeJacobCoffeeforce-pushed the 1168_add_backport_directive branch from 6a97bbd to 35e855bCompareSeptember 28, 2023 01:15
@AA-Turner
Copy link
Member

Please avoid force-pushing, it makes reviewing in the GH interface much harder. PRs are squash merged.

A

Copy link
Member

@AA-TurnerAA-Turner 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

Sign up for freeto 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

@JacobCoffee@AA-Turner@vstinner@hugovk