Update docs on Reload()

[macquigg]

BPO	919099
Nosy	@smontanaro
Files	LibRefReload.pdf: reload description with changes highlighted

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/smontanaro'
closed_at = <Date 2004-03-19.15:30:24.000>
created_at = <Date 2004-03-18.22:06:06.000>
labels = ['docs']
title = 'Update docs on Reload()'
updated_at = <Date 2004-03-19.15:30:24.000>
user = 'https://bugs.python.org/macquigg'

bugs.python.org fields:

activity = <Date 2004-03-19.15:30:24.000>
actor = 'skip.montanaro'
assignee = 'skip.montanaro'
closed = True
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2004-03-18.22:06:06.000>
creator = 'macquigg'
dependencies = []
files = ['1229']
hgrepos = []
issue_num = 919099
keywords = []
message_count = 2.0
messages = ['20267', '20268']
nosy_count = 2.0
nosy_names = ['skip.montanaro', 'macquigg']
pr_nums = []
priority = 'normal'
resolution = 'accepted'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue919099'
versions = []

[macquigg]

The current description of the reload() function in the
Library Reference Manual, Release 2.3.3, Section 2.1
provides lots of detail, but not enough basic
explanation. As a result, there is lots of confusion on
the use of reload, in the mailing lists, and even in texts
on Python. The attached PDF file shows the text from
the manual, with my suggested edits highlighted in
yellow.

The main change is to add a much more detailed
description of what happens when a module is reloaded.
Reloads were always a mystery to me, until I started
thinking about what is happening to the namespaces.

A minor edit: I replaced "re-parse and re-initialize"
with "re-compile and reload", since I think many users
won't know exactly what the former terms mean in this
context. I'm not very familiar with the documentation,
so I don't know if the former terms might be preferred,
so as to be consistent with other documents.

See
http://ece.arizona.edu/~edatools/Python/Reload.htm for
an introductory description of reload, with examples and
exercises and a few paragraphs on why reload can never
work the way many users expect it to.

-- Dave

[smontanaro]

Logged In: YES
user_id=44345

Accepted with a few changes.