| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
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.
Sorry, something went wrong.
| 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
Sorry, something went wrong.
|
Nice, just three Sphinx warnings left: Warning: py:meth reference target not found: close Warning: py:meth reference target not found: get* Warning: py:meth reference target not found: set* For the first one, I think we can just add an exclamation mark, because I don't think we know which close it is in this context? For the last two, we can either add an exclamation mark (for example, :meth:!get*) or list the actual methods, but there's quite a lot, so !` is good. When there's no longer any warnings in wave.rst, we can remove it from Doc/tools/.nitignore, then the CI won't allow new warnings back into wave.rst. |
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 :meth: markup and use preformatted text instead. 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.
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 3.12 due to a conflict. |
Sorry, something went wrong.
|
Sorry @vstinner, I had trouble checking out the 3.11 backport branch. |
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)
|
GH-105138 is a backport of this pull request to the 3.12 branch. |
Sorry, something went wrong.
…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)
| Back | FazBrowse Home | New Git URL |
Add ".. class::" markups in the wave documentation.
📚 Documentation preview 📚: https://cpython-previews--105136.org.readthedocs.build/