gh-105096: Reformat wave documentation#105136
Conversation
Add ".. class::" markups in the wave documentation. * Reformat also wave.py (minor PEP 8 changes). * Remove redundant "import struct": it's already imported at top level.
| The :mod:`wave` module provides a convenient interface to the WAV sound format. | ||
| Only PCM encoded wave files are supported. | ||
| The :mod:`wave` module provides a convenient interface to the Waveform Audio | ||
| "WAVE" (or "WAV") file format. Only uncompressed PCM encoded wave files are |
There was a problem hiding this comment.
The wave.py file only uses "WAVE" name, whereas the doc only uses "WAV" name. The Wikipedia article is called "WAV" and says that the format is called "WAVE". The Python module is called "wave". I'm confused :-) https://en.wikipedia.org/wiki/WAV
|
Nice, just three Sphinx warnings left: For the first one, I think we can just add an exclamation mark, because I don't think we know which For the last two, we can either add an exclamation mark (for example, When there's no longer any warnings in |
|
Oh and let's backport this to 3.11, I'll add the labels. |
Interesting. I tried to fix them.
I used the lazy fix: I removed I will wait for your new review. Tell me if you want further changes. The new code looks good: https://cpython-previews--105136.org.readthedocs.build/en/105136/library/wave.html#wave-read-objects I'm not excited by wave.Wave_write documentation, but I was too lazy to come up with something better. |
hugovk
left a comment
There was a problem hiding this comment.
Thanks, a definite improvement!
|
Thanks @vstinner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12. |
|
Sorry, @vstinner, I could not cleanly backport this to |
|
Sorry @vstinner, I had trouble checking out the |
Add ".. class::" markups in the wave documentation. * Reformat also wave.py (minor PEP 8 changes). * Remove redundant "import struct": it's already imported at top level. * Remove wave.rst from .nitignore (cherry picked from commit 85e5d03)
|
GH-105138 is a backport of this pull request to the 3.12 branch. |
…ython#105138) pythongh-105096: Reformat wave documentation (python#105136) Add ".. class::" markups in the wave documentation. * Reformat also wave.py (minor PEP 8 changes). * Remove redundant "import struct": it's already imported at top level. * Remove wave.rst from .nitignore (cherry picked from commit 85e5d03) (cherry picked from commit 01b42f9)
…05155) [3.12] gh-105096: Reformat wave documentation (#105136) (#105138) gh-105096: Reformat wave documentation (#105136) Add ".. class::" markups in the wave documentation. * Reformat also wave.py (minor PEP 8 changes). * Remove redundant "import struct": it's already imported at top level. * Remove wave.rst from .nitignore (cherry picked from commit 85e5d03) (cherry picked from commit 01b42f9)
Add ".. class::" markups in the wave documentation.
📚 Documentation preview 📚: https://cpython-previews--105136.org.readthedocs.build/