summaryrefslogtreecommitdiffstats
path: root/Objects
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 /Objects
parentc6734ee7c55add5fdc2c821729ed5f67e237a096 (diff)
downloadcpython-4210ad5ebd5769f585035e022876e161cd0e9a3e.zip
cpython-4210ad5ebd5769f585035e022876e161cd0e9a3e.tar.gz
cpython-4210ad5ebd5769f585035e022876e161cd0e9a3e.tar.bz2
bpo-38096: Complete the "structseq" and "named tuple" cleanup (GH-16010)
Diffstat (limited to 'Objects')
-rw-r--r--Objects/structseq.c10
1 files changed, 8 insertions, 2 deletions
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"