[bdieterm]

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

[python-cla-bot]

All commit authors signed the Contributor License Agreement.

[read-the-docs-community]

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...

[aisk]

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.

[bdieterm]

@aisk
done

[aisk]

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.

[bdieterm]

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).

[aisk]

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.

[bdieterm]

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.

[miss-islington-app]

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

[bedevere-app]

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

[aisk]

@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.