[Python-checkins] cpython (3.4): Issue #24861: Add docstring to idlelib.__init__ with 'private' warning.

terry.reedy python-checkins at python.org
Mon Sep 21 07:44:48 CEST 2015


https://hg.python.org/cpython/rev/084a8813f05f
changeset:   98125:084a8813f05f
branch:      3.4
parent:      98121:ae352d27618d
user:        Terry Jan Reedy <tjreedy at udel.edu>
date:        Mon Sep 21 01:44:06 2015 -0400
summary:
  Issue #24861: Add docstring to idlelib.__init__ with 'private' warning.

files:
  Lib/idlelib/__init__.py |  9 ++++++++-
  1 files changed, 8 insertions(+), 1 deletions(-)


diff --git a/Lib/idlelib/__init__.py b/Lib/idlelib/__init__.py
--- a/Lib/idlelib/__init__.py
+++ b/Lib/idlelib/__init__.py
@@ -1,1 +1,8 @@
-# Dummy file to make this a package.
+"""The idlelib package implements the Idle application.
+
+Idle includes an interactive shell and editor.
+Use the files named idle.* to start Idle.
+
+The other files are private implementations.  Their details are subject to
+change.  See PEP 434 for more.  Import them at your own risk.
+"""

-- 
Repository URL: https://hg.python.org/cpython


More information about the Python-checkins mailing list