From 1b0dfb04eaa8461c079e93645bc65f1e12d4789b Mon Sep 17 00:00:00 2001 From: Yuki Kobayashi Date: Fri, 13 Dec 2024 11:23:22 +0000 Subject: [PATCH 1/2] Docs: Fix some typos in the document --- Doc/c-api/init.rst | 8 ++++---- Doc/library/dbm.rst | 2 +- Doc/library/plistlib.rst | 2 +- Doc/library/smtplib.rst | 2 +- Doc/tools/.nitignore | 1 - 5 files changed, 7 insertions(+), 8 deletions(-) diff --git a/Doc/c-api/init.rst b/Doc/c-api/init.rst index f90af6a9ce7c26..9197f704fab344 100644 --- a/Doc/c-api/init.rst +++ b/Doc/c-api/init.rst @@ -604,7 +604,7 @@ Process-wide parameters interpreter will change the contents of this storage. Use :c:func:`Py_DecodeLocale` to decode a bytes string to get a - :c:expr:`wchar_*` string. + :c:expr:`wchar_t*` string. .. deprecated-removed:: 3.11 3.15 @@ -852,7 +852,7 @@ Process-wide parameters directory (``"."``). Use :c:func:`Py_DecodeLocale` to decode a bytes string to get a - :c:expr:`wchar_*` string. + :c:expr:`wchar_t*` string. See also :c:member:`PyConfig.orig_argv` and :c:member:`PyConfig.argv` members of the :ref:`Python Initialization Configuration `. @@ -888,7 +888,7 @@ Process-wide parameters :option:`-I`. Use :c:func:`Py_DecodeLocale` to decode a bytes string to get a - :c:expr:`wchar_*` string. + :c:expr:`wchar_t*` string. See also :c:member:`PyConfig.orig_argv` and :c:member:`PyConfig.argv` members of the :ref:`Python Initialization Configuration `. @@ -914,7 +914,7 @@ Process-wide parameters this storage. Use :c:func:`Py_DecodeLocale` to decode a bytes string to get a - :c:expr:`wchar_*` string. + :c:expr:`wchar_t*` string. .. deprecated-removed:: 3.11 3.15 diff --git a/Doc/library/dbm.rst b/Doc/library/dbm.rst index 6c659ea52ad821..fda24042d55a8b 100644 --- a/Doc/library/dbm.rst +++ b/Doc/library/dbm.rst @@ -455,7 +455,7 @@ The :mod:`!dbm.dumb` module defines the following: .. method:: dumbdbm.sync() Synchronize the on-disk directory and data files. This method is called - by the :meth:`Shelve.sync` method. + by the :meth:`Shelf.sync ` method. .. method:: dumbdbm.close() diff --git a/Doc/library/plistlib.rst b/Doc/library/plistlib.rst index 075b974501e3da..ad96be755b8158 100644 --- a/Doc/library/plistlib.rst +++ b/Doc/library/plistlib.rst @@ -99,7 +99,7 @@ This module defines the following functions: .. function:: dump(value, fp, *, fmt=FMT_XML, sort_keys=True, skipkeys=False, aware_datetime=False) - Write *value* to a plist file. *Fp* should be a writable, binary + Write *value* to a plist file. *fp* should be a writable, binary file object. The *fmt* argument specifies the format of the plist file and can be diff --git a/Doc/library/smtplib.rst b/Doc/library/smtplib.rst index 7cd530a5fd6438..c5f8516f768a68 100644 --- a/Doc/library/smtplib.rst +++ b/Doc/library/smtplib.rst @@ -524,7 +524,7 @@ An :class:`SMTP` instance has the following methods: :mailheader:`Bcc` or :mailheader:`Resent-Bcc` headers that may appear in *msg*. If any of the addresses in *from_addr* and *to_addrs* contain non-ASCII characters and the server does not advertise ``SMTPUTF8`` support, - an :exc:`SMTPNotSupported` error is raised. Otherwise the ``Message`` is + an :exc:`SMTPNotSupportedError` is raised. Otherwise the ``Message`` is serialized with a clone of its :mod:`~email.policy` with the :attr:`~email.policy.EmailPolicy.utf8` attribute set to ``True``, and ``SMTPUTF8`` and ``BODY=8BITMIME`` are added to *mail_options*. diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore index ad24fe82f754fc..9617de0d2f9f63 100644 --- a/Doc/tools/.nitignore +++ b/Doc/tools/.nitignore @@ -16,7 +16,6 @@ Doc/library/ast.rst Doc/library/asyncio-extending.rst Doc/library/asyncio-subprocess.rst Doc/library/collections.rst -Doc/library/dbm.rst Doc/library/decimal.rst Doc/library/email.charset.rst Doc/library/email.compat32-message.rst From 3c18d98f284d3ad66934bd6be6e7f1c8af8728c7 Mon Sep 17 00:00:00 2001 From: Yuki Kobayashi Date: Tue, 11 Feb 2025 12:41:02 +0900 Subject: [PATCH 2/2] Update Doc/library/dbm.rst Co-authored-by: Sergey B Kirpichev --- Doc/library/dbm.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/library/dbm.rst b/Doc/library/dbm.rst index fda24042d55a8b..36221c026d6d4b 100644 --- a/Doc/library/dbm.rst +++ b/Doc/library/dbm.rst @@ -455,7 +455,7 @@ The :mod:`!dbm.dumb` module defines the following: .. method:: dumbdbm.sync() Synchronize the on-disk directory and data files. This method is called - by the :meth:`Shelf.sync ` method. + by the :meth:`shelve.Shelf.sync` method. .. method:: dumbdbm.close()