Skip to content

gh-105096: Reformat wave documentation #105136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vstinner merged 4 commits into from
May 31, 2023
Merged

gh-105096: Reformat wave documentation #105136

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
54825f4
gh-105096: Reformat wave documentation
vstinner May 31, 2023
fc2b220
Fix 3 Sphinx warnings
vstinner May 31, 2023
d6a87cf
Fix formatting
vstinner May 31, 2023
1c848ba
Remove wave.rst from .nitignore
vstinner May 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix 3 Sphinx warnings
  • Loading branch information
@vstinner
vstinner committed May 31, 2023
commit fc2b2201a8ce267a4b35a8a396888b7dd6862f9c
6 changes: 3 additions & 3 deletions Doc/library/wave.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The :mod:`wave` module defines the following function and exception:
value for *mode*.

If you pass in a file-like object, the wave object will not close it when its
:meth:`close` method is called; it is the caller's responsibility to close
``close()`` method is called; it is the caller's responsibility to close
the file object.

The :func:`.open` function may be used in a :keyword:`with` statement. When
Expand Down Expand Up @@ -111,7 +111,7 @@ Wave_read Objects

Returns a :func:`~collections.namedtuple` ``(nchannels, sampwidth,
framerate, nframes, comptype, compname)``, equivalent to output of the
:meth:`get\*` methods.
``get*()`` methods.


.. method:: readframes(n)
Expand Down Expand Up @@ -222,7 +222,7 @@ Wave_write Objects
.. method:: setparams(tuple)

The *tuple* should be ``(nchannels, sampwidth, framerate, nframes, comptype,
compname)``, with values valid for the :meth:`set\*` methods. Sets all
compname)``, with values valid for the ``set*()`` methods. Sets all
parameters.


Expand Down