GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-60729: Add missing `versionadded`/`versionchanged` tags to `wave` module by bdieterm · Pull Request #159644 · python/cpython

Conversation

@bdieterm

@bdieterm bdieterm commented Oct 17, 2026 •
edited by bedevere-app Bot
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

This change adds the missing versionadded info to the docs of method setformat in the wave module.

related:

versionadded tags added only for getformat
#153897

introduction of getformat and setformat in the wave module
#145931

  • Issue: wave file module does not support 32bit float format #60729

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@python-cla-bot

python-cla-bot Bot commented Oct 17, 2026 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

CLA signed

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-app bedevere-app Bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 17, 2026
@github-project-automation github-project-automation Bot added this to Docs PRs Oct 17, 2026
@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Oct 17, 2026
@read-the-docs-community

read-the-docs-community Bot commented Oct 17, 2026 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #35287690 | 📁 Comparing 21361fc against main (18f3a71)

  🔍 Preview build  

24 files changed · ± 24 modified

± Modified

  • py-modindex.html
  • c-api/extension-modules.html
  • c-api/file.html
  • c-api/import.html
  • c-api/interp-lifecycle.html
  • c-api/intro.html
  • c-api/structures.html
  • library/ast.html
  • library/bdb.html
  • library/ctypes.html
  • and 14 more...
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@picnixz picnixz changed the title Add versionadded tag to wave module setformat method gh-60729: Add versionadded tag to wave.setformat method Oct 19, 2026
@bedevere-app bedevere-app Bot added the type-feature A feature request or enhancement label Oct 19, 2026
@bedevere-app bedevere-app Bot mentioned this pull request Oct 19, 2026
wave file module does not support 32bit float format #60729
Closed
@aisk

aisk commented Oct 20, 2026

Copy link
Copy Markdown
Member

WAVE_FORMAT_IEEE_FLOAT is added in the same PR https://github.com/python/cpython/pull/145931/changes, so please also add a versionadded directive for it.

And the setparams method adds support for 7 items tuple, so we should add a versionchanged directive for it.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@aisk aisk removed the type-feature A feature request or enhancement label Oct 20, 2026
@bdieterm
gh-60729: Add missing versionadded/versionchanged tags to wave module (…
bf66fd3
…#159644)
@bdieterm
bdieterm force-pushed the update-wave-docs branch from 18f3ba8 to bf66fd3 Compare October 20, 2026 19:50
@bedevere-app bedevere-app Bot added the type-feature A feature request or enhancement label Oct 20, 2026
@bdieterm bdieterm changed the title gh-60729: Add versionadded tag to wave.setformat method gh-60729: Add missing versionadded/versionchanged tags to wave module Oct 20, 2026
@bdieterm

bdieterm commented Oct 20, 2026

Copy link
Copy Markdown
Contributor Author

@aisk
done

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@aisk

aisk commented Oct 21, 2026

Copy link
Copy Markdown
Member

The other two constant except WAVE_FORMAT_IEEE_FLOAT is not added in 3.15, it's document is just added in 3.15, so please remove them.

And please don't using force push in the future in, as the DevGuide mentioned.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bdieterm
fix/update versionadded tags for WAVE_FORMAT_ constants
21361fc
@bdieterm

bdieterm commented Oct 21, 2026

Copy link
Copy Markdown
Contributor Author

The other two constant except WAVE_FORMAT_IEEE_FLOAT is not added in 3.15, it's document is just added in 3.15, so please remove them.

The constant WAVE_FORMAT_EXTENSIBLE was added in 3.12, so I keep the versionadded but with the updated version number. Or should this be a new PR/commit so that this can be backported to <= 3.14?

And please don't using force push in the future in, as the DevGuide mentioned.

Thanks, now I know about the DevGuide. As far as I understand, this is only to make it easier for reviewers to see what changed (see here).

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

aisk
aisk approved these changes Oct 21, 2026
View reviewed changes
@bedevere-app bedevere-app Bot added awaiting core review and removed awaiting review labels Oct 21, 2026
@aisk

aisk commented Oct 21, 2026

Copy link
Copy Markdown
Member

The constant WAVE_FORMAT_EXTENSIBLE was added in 3.12, so I keep the versionadded but with the updated version number. Or should this be a new PR/commit so that this can be backported to <= 3.14?

versionadded:: 3.12 is fine, since #145931 wasn't backported to 3.14, this PR doesn't need to be either.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@aisk aisk added the needs backport to 3.15 bugs and security fixes label Oct 21, 2026
@bdieterm

bdieterm commented Oct 21, 2026

Copy link
Copy Markdown
Contributor Author

versionadded:: 3.12 is fine, since #145931 wasn't backported to 3.14, this PR doesn't need to be either.

My question about the backport was for a different issue:
Currently, the docs for Python 3.12, 3.13, 3.14, 3.15, and main are missing versionadded:: 3.12 for the constant WAVE_FORMAT_EXTENSIBLE, which was introduced in Python 3.12.
This PR will only fix that for Python >= v3.15 (assuming a backport to 3.15).
After this PR is merged, the docs of 3.12, 3.13, and 3.14 will still miss versionadded:: 3.12 for the constant WAVE_FORMAT_EXTENSIBLE.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

StanFromIreland
StanFromIreland reviewed Oct 21, 2026
View reviewed changes
Comment thread Doc/library/wave.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

@StanFromIreland
Update Doc/library/wave.rst
1ab3594
StanFromIreland
StanFromIreland approved these changes Oct 21, 2026
View reviewed changes
@bedevere-app bedevere-app Bot removed the awaiting core review label Oct 21, 2026
@bedevere-app bedevere-app Bot added the awaiting merge label Oct 21, 2026
@StanFromIreland
StanFromIreland enabled auto-merge (squash) October 21, 2026 17:41
@StanFromIreland
StanFromIreland merged commit 69d0f96 into python:main Oct 21, 2026
33 of 34 checks passed

Uh oh!

There was an error while loading. Please reload this page.

@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Oct 21, 2026
@miss-islington-app

miss-islington-app Bot commented Oct 21, 2026

Copy link
Copy Markdown

Thanks @bdieterm for the PR, and @StanFromIreland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.15.
🐍🍒⛏🤖

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-app bedevere-app Bot removed the awaiting merge label Oct 21, 2026
@bedevere-app

bedevere-app Bot commented Oct 21, 2026

Copy link
Copy Markdown

GH-160079 is a backport of this pull request to the 3.15 branch.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 bugs and security fixes label Oct 21, 2026
@bdieterm
bdieterm deleted the update-wave-docs branch October 21, 2026 17:51
@aisk

aisk commented Oct 21, 2026

Copy link
Copy Markdown
Member

@bdieterm To clarify, WAVE_FORMAT_EXTENSIBLE was introduced in 3.12, but its documentation was only added in #145931 for 3.15. Backporting the relevant docs would take extra work since that PR also adds functionality. I'd prefer not to backport this, as most people read the latest docs, which show when it was added.

bdieterm reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

StanFromIreland added a commit that referenced this pull request Oct 21, 2026
@miss-islington @bdieterm @StanFromIreland
[3.15] gh-60729: Add missing version{added,changed} directives to t…
c195599
…he `wave` docs (GH-159644) (#160079)

(cherry picked from commit 69d0f96)

Co-authored-by: bdieterm <[email protected]>
Co-authored-by: Stan Ulbrych <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aisk aisk aisk approved these changes
@StanFromIreland StanFromIreland StanFromIreland approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news type-feature A feature request or enhancement

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@bdieterm @aisk @StanFromIreland
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.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.