[Python-checkins] Doc: No need to use rst syntax in code comments. (GH-93102)

JulienPalard webhook-mailer at python.org
Mon May 23 17:45:20 EDT 2022


https://github.com/python/cpython/commit/e739ff141680fd7e2a762cf98c4352c6c850af1f
commit: e739ff141680fd7e2a762cf98c4352c6c850af1f
branch: main
author: Julien Palard <julien at palard.fr>
committer: JulienPalard <julien at palard.fr>
date: 2022-05-23T23:45:16+02:00
summary:

Doc: No need to use rst syntax in code comments. (GH-93102)

And it raises `make suspicious` false positives.

files:
M Doc/whatsnew/3.11.rst

diff --git a/Doc/whatsnew/3.11.rst b/Doc/whatsnew/3.11.rst
index ff94e45f77c70..12b4c22d54807 100644
--- a/Doc/whatsnew/3.11.rst
+++ b/Doc/whatsnew/3.11.rst
@@ -314,7 +314,7 @@ transforms a class, giving it :func:`dataclasses.dataclass`-like behaviors.
 
 For example::
 
-    # The ``create_model`` decorator is defined by a library.
+    # The create_model decorator is defined by a library.
     @typing.dataclass_transform()
     def create_model(cls: Type[T]) -> Type[T]:
         cls.__init__ = ...
@@ -322,7 +322,7 @@ For example::
         cls.__ne__ = ...
         return cls
 
-    # The ``create_model`` decorator can now be used to create new model
+    # The create_model decorator can now be used to create new model
     # classes, like this:
     @create_model
     class CustomerModel:



More information about the Python-checkins mailing list