bpo-38096: Complete the "structseq" and "named tuple" cleanup (GH-16010) (GH-16063)

(cherry picked from commit 4210ad5ebd5769f585035e022876e161cd0e9a3e)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>

diff --git a/Doc/glossary.rst b/Doc/glossary.rst
index 3aa54b9eff9e81007bc48fb788a4b3dad6742392..8af4373b11d7c9ea9c075cb050e430acc87f12d1 100644 (file)
--- a/Doc/glossary.rst
+++ b/Doc/glossary.rst
@@ -753,7 +753,7 @@ Glossary
       Some named tuples are built-in types (such as the above examples).
       Alternatively, a named tuple can be created from a regular class
       definition that inherits from :class:`tuple` and that defines named
-      fields.  Such as class can be written by hand or it can be created with
+      fields.  Such a class can be written by hand or it can be created with
       the factory function :func:`collections.namedtuple`.  The latter
       technique also adds some extra methods that may not be found in
       hand-written or built-in named tuples.

diff --git a/Objects/structseq.c b/Objects/structseq.c
index e48165dcd0087f5c34c99a8947260ea04246681e..c71898fd79c0917d3832c86e4c51e7f4f91508aa 100644 (file)
--- a/Objects/structseq.c
+++ b/Objects/structseq.c
@@ -1,5 +1,11 @@
-/* Implementation helper: a struct that looks like a tuple.  See timemodule
-   and posixmodule for example uses. */
+/* Implementation helper: a struct that looks like a tuple.
+   See timemodule and posixmodule for example uses.
+
+   The structseq helper is considered an internal CPython implementation
+   detail.  Docs for modules using structseqs should call them
+   "named tuples" (be sure to include a space between the two
+   words and add a link back to the term in Docs/glossary.rst).
+*/
 
 #include "Python.h"
 #include "structmember.h"