summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRaymond Hettinger <rhettinger@users.noreply.github.com>2019-09-12 14:56:28 (GMT)
committerGitHub <noreply@github.com>2019-09-12 14:56:28 (GMT)
commit4210ad5ebd5769f585035e022876e161cd0e9a3e (patch)
tree172b387b8f630ad47ba27b8bff8defe9bc62635d
parentc6734ee7c55add5fdc2c821729ed5f67e237a096 (diff)
downloadcpython-4210ad5ebd5769f585035e022876e161cd0e9a3e.zip
cpython-4210ad5ebd5769f585035e022876e161cd0e9a3e.tar.gz
cpython-4210ad5ebd5769f585035e022876e161cd0e9a3e.tar.bz2
bpo-38096: Complete the "structseq" and "named tuple" cleanup (GH-16010)
-rw-r--r--Doc/glossary.rst2
-rw-r--r--Objects/structseq.c10
2 files changed, 9 insertions, 3 deletions
diff --git a/Doc/glossary.rst b/Doc/glossary.rst
index 84d0fca..e601e8b 100644
--- a/Doc/glossary.rst
+++ b/Doc/glossary.rst
@@ -757,7 +757,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 2c25e16..320bf08 100644
--- 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 "pycore_tupleobject.h"