Skip to content
Merged
7 changes: 0 additions & 7 deletions CHANGELOG.md

This file was deleted.

16 changes: 15 additions & 1 deletion content/changelog/2024-07-12-function-signatures.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
author: ["Ned Batchelder"]
Copy link
Member

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"?

Copy link
Member Author

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.

title: "Changelog: July 12, 2024"
title: "Function signatures include slash and star"
date: "2024-07-12"
tags: ["changelog"]
categories: ["changelog"]
Expand All @@ -10,3 +10,17 @@ TocOpen: false
---

Function signatures should include slash and star: https://github.com/python/devguide/pull/1344

## Summary

If a function accepts positional-only or keyword-only arguments, include the
slash and the star in the signature as appropriate.

```rst
.. function:: some_function(pos1, pos2, /, pos_or_kwd, *, kwd1, kwd2):
```

Although the syntax is terse, it is precise about the allowable ways to call
the function and is taken from Python itself.

The CPython Devguide has been updated to reflect [this recommendation](https://devguide.python.org/documentation/style-guide/#function-signatures).
17 changes: 16 additions & 1 deletion content/changelog/2024-07-18-clarify-timezone.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
author: ["Ned Batchelder"]
title: "Changelog: July 18, 2024"
title: "Timezone vs time zone"
date: "2024-07-18"
tags: ["changelog"]
categories: ["changelog"]
Expand All @@ -10,3 +10,18 @@ TocOpen: false
---

Clarify `timezone` vs "time zone": https://github.com/python/devguide/pull/1352

## Summary

The CPython PR [#118449](https://github.com/python/cpython/pull/118449) updates the spelling of "timezone" to "time zone".
There was a discussion
on the PR that the "timezone" spelling is also acceptable and have been used within the CPython docs
consistently. However, both Wikipedia and The Free Dictionary redirect "timezone" to "time zone".

Using the two-word form "time zone" would help separate the concept from the "timezone" class in Python.

The [Style Guide](https://devguide.python.org/documentation/style-guide/#style-guide) section on CPython Devguide has
now been updated with the recommendation of using the
two word `time zone` when referring to the real-world time concept, and to use the one word `timezone` with
appropriate code markup when referring to a Python term.

17 changes: 17 additions & 0 deletions content/changelog/2024-08-28-style-guide-recs.md
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__`).
16 changes: 16 additions & 0 deletions content/changelog/2024-10-14-devguide-reorg.md
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.
20 changes: 20 additions & 0 deletions content/changelog/2024-11-11-dead-batteries-docs.md
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.
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.

1 change: 1 addition & 0 deletions content/changelog/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Editorial Board Decisions"
layout: "changelog"
---

Editorial Board Decisions
Expand Down
4 changes: 2 additions & 2 deletions hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ baseURL: "https://python.github.io/editorial-board/"
title: Python Docs Editorial Board
copyright: "© [Python Docs Editorial Board and Contributors](https://github.com/python/editorial-board/graphs/contributors)"
pagination:
pagerSize: 5
pagerSize: 10

enableInlineShortcodes: true
enableRobotsTXT: true
Expand Down Expand Up @@ -31,7 +31,7 @@ params:
defaultTheme: auto
# disableThemeToggle: true
ShowShareButtons: true
ShowReadingTime: true
ShowReadingTime: false
# disableSpecial1stPost: true
displayFullLangName: true
ShowPostNavLinks: true
Expand Down
154 changes: 154 additions & 0 deletions layouts/changelog/list.html
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 }}">
«&nbsp;{{ i18n "prev_page" }}&nbsp;
{{- 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" }}&nbsp;
{{- if (.Param "ShowPageNums") }}
{{- add 1 $paginator.PageNumber }}/{{ $paginator.TotalPages }}
{{- end }}&nbsp;»
</a>
{{- end }}
</nav>
</footer>
{{- end }}

{{- end }}{{/* end profileMode */}}

{{- end }}{{- /* end main */ -}}
32 changes: 17 additions & 15 deletions layouts/partials/members.html
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>