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.
Sorry, something went wrong.
|
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 |
Sorry, something went wrong.
|
Oh and let's backport this to 3.11, I'll add the labels. |
Sorry, something went wrong.
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. |
Sorry, something went wrong.
hugovk
left a comment
There was a problem hiding this comment.
Thanks, a definite improvement!
Sorry, something went wrong.
|
Thanks @vstinner for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12. |
Sorry, something went wrong.
|
Sorry, @vstinner, I could not cleanly backport this to |
Sorry, something went wrong.
|
Sorry @vstinner, I had trouble checking out the |
Sorry, something went wrong.
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)
…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/