From 068677ce25e1b902748cd0ffac82db4b2bf1250a Mon Sep 17 00:00:00 2001 From: Nikita Sobolev Date: Tue, 11 Apr 2023 16:50:25 +0300 Subject: [PATCH] gh-87864: Use correct function definition syntax in the docs (GH-103312) (cherry picked from commit 50b4b1598411ed393f47ce7f4fffbe5b9063cd42) Co-authored-by: Nikita Sobolev --- Doc/glossary.rst | 2 +- Doc/library/functions.rst | 2 +- Lib/abc.py | 2 +- Objects/funcobject.c | 8 ++++---- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Doc/glossary.rst b/Doc/glossary.rst index 3d74d550dc345a..53e8cdcae1cd66 100644 --- a/Doc/glossary.rst +++ b/Doc/glossary.rst @@ -214,7 +214,7 @@ Glossary A callable is an object that can be called, possibly with a set of arguments (see :term:`argument`), with the following syntax:: - callable(argument1, argument2, ...) + callable(argument1, argument2, argumentN) A :term:`function`, and by extension a :term:`method`, is a callable. An instance of a class that implements the :meth:`~object.__call__` diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index 2ce3860440be77..1c3deb2e78c762 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -1677,7 +1677,7 @@ are always available. They are listed here in alphabetical order. class C: @staticmethod - def f(arg1, arg2, ...): ... + def f(arg1, arg2, argN): ... The ``@staticmethod`` form is a function :term:`decorator` -- see :ref:`function` for details. diff --git a/Lib/abc.py b/Lib/abc.py index 42048ddb855381..f8a4e11ce9c3b1 100644 --- a/Lib/abc.py +++ b/Lib/abc.py @@ -18,7 +18,7 @@ class that has a metaclass derived from ABCMeta cannot be class C(metaclass=ABCMeta): @abstractmethod - def my_abstract_method(self, ...): + def my_abstract_method(self, arg1, arg2, argN): ... """ funcobj.__isabstractmethod__ = True diff --git a/Objects/funcobject.c b/Objects/funcobject.c index 57600c97e6aa31..3a0553261bf132 100644 --- a/Objects/funcobject.c +++ b/Objects/funcobject.c @@ -845,7 +845,7 @@ functools_wraps(PyObject *wrapper, PyObject *wrapped) class C: @classmethod - def f(cls, arg1, arg2, ...): + def f(cls, arg1, arg2, argN): ... It can be called either on the class (e.g. C.f()) or on an instance @@ -970,7 +970,7 @@ To declare a class method, use this idiom:\n\ \n\ class C:\n\ @classmethod\n\ - def f(cls, arg1, arg2, ...):\n\ + def f(cls, arg1, arg2, argN):\n\ ...\n\ \n\ It can be called either on the class (e.g. C.f()) or on an instance\n\ @@ -1043,7 +1043,7 @@ PyClassMethod_New(PyObject *callable) class C: @staticmethod - def f(arg1, arg2, ...): + def f(arg1, arg2, argN): ... It can be called either on the class (e.g. C.f()) or on an instance @@ -1167,7 +1167,7 @@ To declare a static method, use this idiom:\n\ \n\ class C:\n\ @staticmethod\n\ - def f(arg1, arg2, ...):\n\ + def f(arg1, arg2, argN):\n\ ...\n\ \n\ It can be called either on the class (e.g. C.f()) or on an instance\n\