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.

Sign up for GitHub

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

Jump to bottom

Update description of CPython docs publish frequency #1315

Closed
hugovk opened this issue May 1, 2024 · 1 comment
Closed

Update description of CPython docs publish frequency #1315

hugovk opened this issue May 1, 2024 · 1 comment
Labels
bug good first issue New contributors guide-edits Editing of doc or content needed help wanted

Comments

@hugovk
Copy link
Member

hugovk commented May 1, 2024

Describe the bug

https://devguide.python.org/documentation/devguide/ says:

Our devguide workflow uses continuous integration and deployment so changes to the devguide are normally published when the pull request is merged. Changes to CPython documentation follow the workflow of a CPython release and are published in the release.

Expected behavior

The last sentence isn't the whole story; the docs are also updated about once a day. Let's update it to just mention the daily update.
@hugovk hugovk added bug help wanted good first issue New contributors guide-edits Editing of doc or content needed labels May 1, 2024
@ycaglar ycaglar mentioned this issue May 4, 2024
Closed
miguelcsx added a commit to miguelcsx/devguide that referenced this issue Sep 11, 2024
@miguelcsx
refac: python#1315 clarify cpython documentation update process
9a9221a 
- update the documentation to specify that cpython docs are updated daily

- removed the previous implication that updates occur only with cpython
  releases

  - clarified the connection between daily updates and the cpython
    release workflow
@hugovk hugovk mentioned this issue Sep 11, 2024
Merged
miguelcsx added a commit to miguelcsx/devguide that referenced this issue Sep 11, 2024
@miguelcsx
refac: python#1315 clarify cpython documentation update process
34dc1ce 
- updated the explanation of cpython documentation updates

- specified that updates occur regularly, tipically within a day or two

- clarified that the documentation is versioned for each cpython release

- improved the clarity of the relationship between releases and versions
@hugovk
Copy link
Member Author

hugovk commented Sep 19, 2024

Fixed by #1395.

@hugovk hugovk closed this as completed Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug good first issue New contributors guide-edits Editing of doc or content needed help wanted
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Clarify CPython Documentation Update Intervals
1 participant
@hugovk