gh-107162: Document errcode.h usage in its comment (#107177)

Public and documented PyRun_InteractiveOneFlags() C API uses it.

diff --git a/Include/errcode.h b/Include/errcode.h
index 54ae929bf258703845c0c832585ffa9595ee7da0..8d44e9ae55919389df49c44b4f4db3bdaf3aea29 100644 (file)
--- a/Include/errcode.h
+++ b/Include/errcode.h
@@ -1,18 +1,24 @@
+// Error codes passed around between file input, tokenizer, parser and
+// interpreter.  This is necessary so we can turn them into Python
+// exceptions at a higher level.  Note that some errors have a
+// slightly different meaning when passed from the tokenizer to the
+// parser than when passed from the parser to the interpreter; e.g.
+// the parser only returns E_EOF when it hits EOF immediately, and it
+// never returns E_OK.
+//
+// The public PyRun_InteractiveOneObjectEx() function can return E_EOF,
+// same as its variants:
+//
+// * PyRun_InteractiveOneObject()
+// * PyRun_InteractiveOneFlags()
+// * PyRun_InteractiveOne()
+
 #ifndef Py_ERRCODE_H
 #define Py_ERRCODE_H
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-
-/* Error codes passed around between file input, tokenizer, parser and
-   interpreter.  This is necessary so we can turn them into Python
-   exceptions at a higher level.  Note that some errors have a
-   slightly different meaning when passed from the tokenizer to the
-   parser than when passed from the parser to the interpreter; e.g.
-   the parser only returns E_EOF when it hits EOF immediately, and it
-   never returns E_OK. */
-
 #define E_OK            10      /* No error */
 #define E_EOF           11      /* End Of File */
 #define E_INTR          12      /* Interrupted */