From 9e5a48f29092c63ac2ddf3ce6b2398ece824813e Mon Sep 17 00:00:00 2001 From: Nikita Sobolev Date: Fri, 1 Sep 2023 13:44:43 +0300 Subject: [PATCH] gh-101100: Fix sphinx warnings in `tutorial/classes.rst` (GH-108746) (cherry picked from commit e775601ef1ada83a80e1539d0bcd5509deadee14) Co-authored-by: Nikita Sobolev --- Doc/tools/.nitignore | 1 - Doc/tutorial/classes.rst | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore index 871a48282523c4..ab7f4a8dc618b9 100644 --- a/Doc/tools/.nitignore +++ b/Doc/tools/.nitignore @@ -158,7 +158,6 @@ Doc/reference/expressions.rst Doc/reference/import.rst Doc/reference/simple_stmts.rst Doc/tutorial/appendix.rst -Doc/tutorial/classes.rst Doc/tutorial/controlflow.rst Doc/tutorial/datastructures.rst Doc/tutorial/introduction.rst diff --git a/Doc/tutorial/classes.rst b/Doc/tutorial/classes.rst index e4002cfa351936..46dfb378590ffb 100644 --- a/Doc/tutorial/classes.rst +++ b/Doc/tutorial/classes.rst @@ -276,7 +276,7 @@ definition looked like this:: then ``MyClass.i`` and ``MyClass.f`` are valid attribute references, returning an integer and a function object, respectively. Class attributes can also be assigned to, so you can change the value of ``MyClass.i`` by assignment. -:attr:`__doc__` is also a valid attribute, returning the docstring belonging to +:attr:`!__doc__` is also a valid attribute, returning the docstring belonging to the class: ``"A simple example class"``. Class *instantiation* uses function notation. Just pretend that the class