Skip to content

gh-129667: Update annotation in documentation #129669

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.

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions Doc/library/codecs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -607,9 +607,9 @@ define in order to be compatible with the Python codec registry.
object.


.. method:: encode(object, final=False)
.. method:: encode(input, final=False)

Encodes *object* (taking the current state of the encoder into account)
Encodes *input* (taking the current state of the encoder into account)
and returns the resulting encoded object. If this is the last call to
:meth:`encode` *final* must be true (the default is false).

Expand Down Expand Up @@ -664,9 +664,9 @@ define in order to be compatible with the Python codec registry.
object.


.. method:: decode(object, final=False)
.. method:: decode(input, final=False)

Decodes *object* (taking the current state of the decoder into account)
Decodes *input* (taking the current state of the decoder into account)
and returns the resulting decoded object. If this is the last call to
:meth:`decode` *final* must be true (the default is false). If *final* is
true the decoder must decode the input completely and must flush all
Expand Down
12 changes: 6 additions & 6 deletions Doc/library/configparser.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1229,14 +1229,14 @@ ConfigParser Objects
interpolation.


.. method:: set(section, option, value)
.. method:: set(section, option, value=None)

If the given section exists, set the given option to the specified value;
otherwise raise :exc:`NoSectionError`. *option* and *value* must be
strings; if not, :exc:`TypeError` is raised.


.. method:: write(fileobject, space_around_delimiters=True)
.. method:: write(fp, space_around_delimiters=True)

Write a representation of the configuration to the specified :term:`file
object`, which must be opened in text mode (accepting strings). This
Expand Down Expand Up @@ -1266,12 +1266,12 @@ ConfigParser Objects
fact existed, return ``True``. Otherwise return ``False``.


.. method:: optionxform(option)
.. method:: optionxform(optionstr)

Transforms the option name *option* as found in an input file or as passed
Transforms the option name *optionstr* as found in an input file or as passed
in by client code to the form that should be used in the internal
structures. The default implementation returns a lower-case version of
*option*; subclasses may override this or client code can set an attribute
*optionstr*; subclasses may override this or client code can set an attribute
of this name on instances to affect this behavior.

You don't need to subclass the parser to use this method, you can also
Expand Down Expand Up @@ -1354,7 +1354,7 @@ RawConfigParser Objects
Added support for :const:`UNNAMED_SECTION`.


.. method:: set(section, option, value)
.. method:: set(section, option, value=None)

If the given section exists, set the given option to the specified value;
otherwise raise :exc:`NoSectionError`. While it is possible to use
Expand Down
4 changes: 2 additions & 2 deletions Doc/library/enum.rst
Original file line number Diff line number Diff line change
Expand Up @@ -196,9 +196,9 @@ Data Types
:start: The first integer value for the Enum (used by :class:`auto`).
:boundary: How to handle out-of-range values from bit operations (:class:`Flag` only).

.. method:: EnumType.__contains__(cls, member)
.. method:: EnumType.__contains__(cls, value)

Returns ``True`` if member belongs to the ``cls``::
Returns ``True`` if value belongs to the ``cls``::

>>> some_var = Color.RED
>>> some_var in Color
Expand Down
10 changes: 6 additions & 4 deletions Doc/library/http.server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,16 @@ handler. Code to create and run the server looks like this::
httpd.serve_forever()


.. class:: HTTPServer(server_address, RequestHandlerClass)
.. class:: HTTPServer(server_address, RequestHandlerClass, \
bind_and_activate=True)

This class builds on the :class:`~socketserver.TCPServer` class by storing
the server address as instance variables named :attr:`server_name` and
:attr:`server_port`. The server is accessible by the handler, typically
through the handler's :attr:`server` instance variable.

.. class:: ThreadingHTTPServer(server_address, RequestHandlerClass)
.. class:: ThreadingHTTPServer(server_address, RequestHandlerClass, \
bind_and_activate=True)

This class is identical to HTTPServer but uses threads to handle
requests by using the :class:`~socketserver.ThreadingMixIn`. This
Expand Down Expand Up @@ -281,14 +283,14 @@ provides three different variants:
HTTP code associated with the response. If a size of the response is
available, then it should be passed as the *size* parameter.

.. method:: log_error(...)
.. method:: log_error(format, *args)

Logs an error when a request cannot be fulfilled. By default, it passes
the message to :meth:`log_message`, so it takes the same arguments
(*format* and additional values).


.. method:: log_message(format, ...)
.. method:: log_message(format, *args)

Logs an arbitrary message to ``sys.stderr``. This is typically overridden
to create custom error logging mechanisms. The *format* argument is a
Expand Down
2 changes: 1 addition & 1 deletion Lib/configparser.py
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@
remove_option(section, option)
Remove the given option from the given section.

set(section, option, value)
set(section, option, value=None)
Set the given option.

write(fp, space_around_delimiters=True)
Expand Down
Loading