Skip to content

gh-156347: Fix the documentation of curses window.encoding #156352

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

Closed
fedonman wants to merge 1 commit into from
+6 −3
Closed

gh-156347: Fix the documentation of curses window.encoding #156352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 1 addition & 2 deletions Doc/howto/curses.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,8 +298,7 @@ the next subsection.
The :meth:`~curses.window.addstr` method takes a Python string or
bytestring as the value to be displayed. The contents of bytestrings
are sent to the terminal as-is. Strings are encoded to bytes using
the value of the window's :attr:`~window.encoding` attribute; this defaults to
the default system encoding as returned by :func:`locale.getencoding`.
the encoding of the current locale (see :func:`locale.getencoding`).

The :meth:`~curses.window.addch` methods take a character, which can be
either a string of length 1, a bytestring of length 1, or an integer.
Expand Down
6 changes: 5 additions & 1 deletion Doc/library/curses.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2002,7 +2002,11 @@ Other

.. attribute:: window.encoding

Encoding used to encode method arguments (Unicode strings and characters).
Encoding used to encode and decode method arguments and results
(Unicode strings and characters) on a narrow build. It is not used on a
build linked against a wide-character version of the underlying curses
library, where strings are passed to curses as wide characters and the
encoding of the current locale determines the bytes.
The encoding attribute is inherited from the parent window when a subwindow
is created, for example with :meth:`window.subwin`.
By default, current locale encoding is used (see :func:`locale.getencoding`).
Expand Down
Loading