From: Georg Brandl <georg@python.org>
Date: Sat, 27 Dec 2008 19:11:15 +0000 (+0000)
Subject: #4671: document that pydoc imports modules.
X-Git-Tag: v2.7a1~2483
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1ffbfbc5666cc304ca00c6da297431e9d2aee6a1;p=thirdparty%2FPython%2Fcpython.git

#4671: document that pydoc imports modules.
---

diff --git a/Doc/library/pydoc.rst b/Doc/library/pydoc.rst
index 6d4986e81c02..37845154776c 100644
--- a/Doc/library/pydoc.rst
+++ b/Doc/library/pydoc.rst
@@ -36,6 +36,13 @@ it contains the path separator for your operating system, such as a slash in
 Unix), and refers to an existing Python source file, then documentation is
 produced for that file.
 
+.. note::
+
+   In order to find objects and their documentation, :mod:`pydoc` imports the
+   module(s) to be documented.  Therefore, any code on module level will be
+   executed on that occasion.  Use an ``if __name__ == '__main__':`` guard to
+   only execute code when a file is invoked as a script and not just imported.
+
 Specifying a :option:`-w` flag before the argument will cause HTML documentation
 to be written out to a file in the current directory, instead of displaying text
 on the console.