-
Notifications
You must be signed in to change notification settings - Fork 1
Update the changelog #28
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
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
a16eac2
Update the changelog
Mariatta 70afb4b
Add more changelog entries
Mariatta d77fdbc
Update content/changelog/2024-08-28-style-guide-recs.md
Mariatta 20fc95f
Update content/changelog/2024-11-11-dead-batteries-docs.md
Mariatta 008808a
Update content/changelog/2024-10-14-devguide-reorg.md
Mariatta 497330a
Merge branch 'main' into update-changelog
Mariatta e967310
Render the Changelog in its entirity instead of snippet
Mariatta 2403745
Render the Changelog in its entirity instead of snippet
Mariatta 83c4add
Fix mistaken commit
Mariatta aa33e3d
Update content/changelog/2025-03-11-pipes-or-in-sphinx-type-descripti…
Mariatta eecbabe
Remove reading time (always very short)
Mariatta File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| --- | ||
| author: ["Ned Batchelder"] | ||
| title: "Style Guide recommendations" | ||
| date: "2024-08-28" | ||
| tags: ["changelog"] | ||
| categories: ["changelog"] | ||
| series: ["Changelog"] | ||
| ShowToc: false | ||
| TocOpen: false | ||
| --- | ||
|
|
||
| Additional recommendations in the Style Guide https://github.com/python/devguide/pull/1377/ | ||
|
|
||
| ## Summary | ||
|
|
||
| The [Style Guide](https://devguide.python.org/documentation/style-guide/) has been updated with new | ||
| recommendations about author attribution (don't include it) and pronunciation of dunder names ("an `__init__`, not `a __init__`). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| --- | ||
| author: ["Mariatta"] | ||
| title: "Devguide Reorganization" | ||
| date: "2024-10-14" | ||
| tags: ["changelog"] | ||
| categories: ["changelog"] | ||
| series: ["Changelog"] | ||
| ShowToc: false | ||
| TocOpen: false | ||
| --- | ||
|
|
||
| Refactoring the devguide into a Contribution Guide https://discuss.python.org/t/refactoring-the-devguide-into-a-contribution-guide/63409 | ||
|
|
||
| ## Summary | ||
|
|
||
| We've started a large task to restructure the devguide to be more welcoming to non-code contributions. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| --- | ||
| author: ["Mariatta"] | ||
| title: "Dead Batteries Docs" | ||
| date: "2025-03-11" | ||
| tags: ["changelog"] | ||
| categories: ["changelog"] | ||
| series: ["Changelog"] | ||
| ShowToc: false | ||
| TocOpen: false | ||
| --- | ||
|
|
||
| History of dead batteries: https://discuss.python.org/t/history-of-dead-batteries/68934 | ||
|
|
||
| Documenting Dead batteries: https://discuss.python.org/t/documenting-dead-batteries/70652 | ||
|
|
||
| PR: https://github.com/python/cpython/pull/126622 | ||
|
|
||
| ## Summary | ||
|
|
||
| The PR adds a "Removed modules" page that lists modules which have been removed. Each module gets a page (with the original URL) that explains why the module is gone. |
40 changes: 40 additions & 0 deletions
40
content/changelog/2025-03-11-pipes-or-in-sphinx-type-descriptions.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| --- | ||
| author: ["Mariatta"] | ||
| title: "``|`` or 'or' in parameter documentation" | ||
| date: "2025-03-11" | ||
| tags: ["changelog"] | ||
| categories: ["changelog"] | ||
| series: ["Changelog"] | ||
| ShowToc: false | ||
| TocOpen: false | ||
| --- | ||
|
|
||
| Additional recommendations in the Style Guide https://github.com/python/devguide/pull/1377/ | ||
|
|
||
| ## Summary | ||
|
|
||
| [Discourse](https://discuss.python.org/t/how-should-we-mark-up-multiple-types-in-a-type-field/48196) topic: How | ||
| should we mark up multiple types in a type field? | ||
|
|
||
| Currently, the Python docs use `|` (pipe) character, similar to how you'd annotate a union of types: | ||
|
|
||
| ```rst | ||
| :param p: | ||
| A parameter that takes an int or a float argument. | ||
| :type p: int | float | ||
| ``` | ||
|
|
||
| However, the [Sphinx docs](https://www.sphinx-doc.org/en/master/usage/domains/python.html#send_message) says to use the word `or`: | ||
|
|
||
| ```rst | ||
| :param p: | ||
| A parameter that takes an int or a float argument. | ||
| :type p: int or float | ||
| ``` | ||
|
|
||
| The editorial board's decision was requested on this matter via [issue #7](https://github.com/python/editorial-board/issues/7). | ||
|
|
||
| The editorial board discussed this over several meetings, our decision is to use the `|` symbol. We met with Adam Turner | ||
| to discuss how this would be implemented in Sphinx. This is supported in the latest version of Sphinx and the CPython | ||
| docs have been built using the latest Sphinx. | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| --- | ||
| title: "Editorial Board Decisions" | ||
| layout: "changelog" | ||
| --- | ||
|
|
||
| Editorial Board Decisions | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| {{- define "main" }} | ||
|
|
||
| {{- if (and site.Params.profileMode.enabled .IsHome) }} | ||
| {{- partial "index_profile.html" . }} | ||
| {{- else }} {{/* if not profileMode */}} | ||
|
|
||
| {{- if not .IsHome | and .Title }} | ||
| <header class="page-header"> | ||
| {{- partial "breadcrumbs.html" . }} | ||
| <h1> | ||
| {{ .Title }} | ||
| {{- if and (or (eq .Kind `term`) (eq .Kind `section`)) (.Param "ShowRssButtonInSectionTermList") }} | ||
| {{- with .OutputFormats.Get "rss" }} | ||
| <a href="{{ .RelPermalink }}" title="RSS" aria-label="RSS"> | ||
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" | ||
| stroke-linecap="round" stroke-linejoin="round" height="23"> | ||
| <path d="M4 11a9 9 0 0 1 9 9" /> | ||
| <path d="M4 4a16 16 0 0 1 16 16" /> | ||
| <circle cx="5" cy="19" r="1" /> | ||
| </svg> | ||
| </a> | ||
| {{- end }} | ||
| {{- end }} | ||
| </h1> | ||
| {{- if .Description }} | ||
| <div class="post-description"> | ||
| {{ .Description | markdownify }} | ||
| </div> | ||
| {{- end }} | ||
| </header> | ||
| {{- end }} | ||
|
|
||
| {{- if .Content }} | ||
| <div class="post-content"> | ||
| {{- if not (.Param "disableAnchoredHeadings") }} | ||
| {{- partial "anchored_headings.html" .Content -}} | ||
| {{- else }}{{ .Content }}{{ end }} | ||
| </div> | ||
| {{- end }} | ||
|
|
||
| {{- $pages := union .RegularPages .Sections }} | ||
|
|
||
| {{- if .IsHome }} | ||
| {{- $pages = where site.RegularPages "Type" "in" site.Params.mainSections }} | ||
| {{- $pages = where $pages "Params.hiddenInHomeList" "!=" "true" }} | ||
| {{- end }} | ||
|
|
||
| {{- $paginator := .Paginate $pages }} | ||
|
|
||
| {{- if and .IsHome site.Params.homeInfoParams (eq $paginator.PageNumber 1) }} | ||
| {{- partial "home_info.html" . }} | ||
| {{- end }} | ||
|
|
||
| {{- $term := .Data.Term }} | ||
| {{- range $index, $page := $paginator.Pages }} | ||
|
|
||
| {{- $class := "post-entry" }} | ||
|
|
||
| {{- $user_preferred := or site.Params.disableSpecial1stPost site.Params.homeInfoParams }} | ||
| {{- if (and $.IsHome (eq $paginator.PageNumber 1) (eq $index 0) (not $user_preferred)) }} | ||
| {{- $class = "first-entry" }} | ||
| {{- else if $term }} | ||
| {{- $class = "post-entry tag-entry" }} | ||
| {{- end }} | ||
|
|
||
| <article class="{{ $class }}"> | ||
| {{- $isHidden := (.Param "cover.hiddenInList") | default (.Param "cover.hidden") | default false }} | ||
| {{- partial "cover.html" (dict "cxt" . "IsSingle" false "isHidden" $isHidden) }} | ||
| <header class="post-header"> | ||
| <h1 class="post-title entry-hint-parent"> | ||
| <a href="{{ .Permalink }}">{{ .Title }}</a> | ||
| {{- if .Draft }} | ||
| <span class="entry-hint" title="Draft"> | ||
| <svg xmlns="http://www.w3.org/2000/svg" height="35" viewBox="0 -960 960 960" fill="currentColor"> | ||
| <path | ||
| d="M160-410v-60h300v60H160Zm0-165v-60h470v60H160Zm0-165v-60h470v60H160Zm360 580v-123l221-220q9-9 20-13t22-4q12 0 23 4.5t20 13.5l37 37q9 9 13 20t4 22q0 11-4.5 22.5T862.09-380L643-160H520Zm300-263-37-37 37 37ZM580-220h38l121-122-18-19-19-18-122 121v38Zm141-141-19-18 37 37-18-19Z" /> | ||
| </svg> | ||
| </span> | ||
| {{- end }} | ||
| </h1> | ||
| {{- if .Description }} | ||
| <div class="post-description"> | ||
| {{ .Description }} | ||
| </div> | ||
| {{- end }} | ||
| {{- if not (.Param "hideMeta") }} | ||
| <div class="post-meta"> | ||
| {{- partial "post_meta.html" . -}} | ||
| {{- partial "translation_list.html" . -}} | ||
| {{- partial "edit_post.html" . -}} | ||
| {{- partial "post_canonical.html" . -}} | ||
| </div> | ||
| {{- end }} | ||
| </header> | ||
| {{- partial "members.html" . }} | ||
|
|
||
| {{- $isHidden := (.Param "cover.hiddenInSingle") | default (.Param "cover.hidden") | default false }} | ||
| {{- partial "cover.html" (dict "cxt" . "IsSingle" true "isHidden" $isHidden) }} | ||
| {{- if (.Param "ShowToc") }} | ||
| {{- partial "toc.html" . }} | ||
| {{- end }} | ||
|
|
||
| {{- if .Content }} | ||
| <div class="post-content"> | ||
| {{- if not (.Param "disableAnchoredHeadings") }} | ||
| {{- partial "anchored_headings.html" .Content -}} | ||
| {{- else }}in content{{ .Content }}{{ end }} | ||
| </div> | ||
| {{- end }} | ||
|
|
||
| <footer class="post-footer"> | ||
| {{- $tags := .Language.Params.Taxonomies.tag | default "tags" }} | ||
| <ul class="post-tags"> | ||
| {{- range ($.GetTerms $tags) }} | ||
| <li><a href="{{ .Permalink }}">{{ .LinkTitle }}</a></li> | ||
| {{- end }} | ||
| </ul> | ||
| {{- if (.Param "ShowPostNavLinks") }} | ||
| {{- partial "post_nav_links.html" . }} | ||
| {{- end }} | ||
| </footer> | ||
|
|
||
| {{- if (.Param "comments") }} | ||
| {{- partial "comments.html" . }} | ||
| {{- end }} | ||
| </article> | ||
| {{- end }} | ||
|
|
||
| {{- if gt $paginator.TotalPages 1 }} | ||
| <footer class="page-footer"> | ||
| <nav class="pagination"> | ||
| {{- if $paginator.HasPrev }} | ||
| <a class="prev" href="{{ $paginator.Prev.URL | absURL }}"> | ||
| « {{ i18n "prev_page" }} | ||
| {{- if (.Param "ShowPageNums") }} | ||
| {{- sub $paginator.PageNumber 1 }}/{{ $paginator.TotalPages }} | ||
| {{- end }} | ||
| </a> | ||
| {{- end }} | ||
| {{- if $paginator.HasNext }} | ||
| <a class="next" href="{{ $paginator.Next.URL | absURL }}"> | ||
| {{- i18n "next_page" }} | ||
| {{- if (.Param "ShowPageNums") }} | ||
| {{- add 1 $paginator.PageNumber }}/{{ $paginator.TotalPages }} | ||
| {{- end }} » | ||
| </a> | ||
| {{- end }} | ||
| </nav> | ||
| </footer> | ||
| {{- end }} | ||
|
|
||
| {{- end }}{{/* end profileMode */}} | ||
|
|
||
| {{- end }}{{- /* end main */ -}} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,19 @@ | ||
| <div class="post-content" id="members"> | ||
| <h3 id="attendees">Attendees</h3> | ||
| <ul> | ||
| {{ range $member := .Param "members" }} | ||
| <li> | ||
| <a href="{{ `members/` | relLangURL }}{{ $member | urlize }}/"> | ||
| {{ $member }} | ||
| </a> | ||
| </li> | ||
| {{ end }} | ||
| {{ range $guest := .Param "guests" }} | ||
| <li> | ||
| {{ $guest}} | ||
| </li> | ||
| {{ end }} | ||
| </ul> | ||
| {{if $.Param "members" }} | ||
| <h3 id="attendees">Attendees</h3> | ||
| <ul> | ||
| {{ range $member := .Param "members" }} | ||
| <li> | ||
| <a href="{{ `members/` | relLangURL }}{{ $member | urlize }}/"> | ||
| {{ $member }} | ||
| </a> | ||
| </li> | ||
| {{ end }} | ||
| {{ range $guest := .Param "guests" }} | ||
| <li> | ||
| {{ $guest}} | ||
| </li> | ||
| {{ end }} | ||
| </ul> | ||
| {{ end }} | ||
| </div> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does it make sense to have individuals listed as authors for changelog snippets, if the board acts with collective responsibility? Perhaps remove the author, or use "the board"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm seeing author as "who wrote up this whole post" as opposed to "who made the decision written in this post", but not sure if the rest of the board feels differently.