[New-bugs-announce] [issue6031] BaseServer.shutdown documentation is incomplete

[Gabriel Genellina]

New submission from Gabriel Genellina <gagsl-py2 at yahoo.com.ar>:

BaseServer.shutdown is documented as "Tells the serve_forever() loop to 
stop and waits until it does."

The docstring is much more explicit: """Stops the serve_forever loop. 
Blocks until the loop has finished. This must be called while 
serve_forever() is running in another thread, or it will deadlock."""

Combined with #2302 I'd rewrite both (rst and docstring) as:

BaseServer.shutdown(): Tells the serve_forever() loop to stop, and 
waits until the loop has finished. This must be called after 
serve_forever() has started and while it is running in another thread, 
or the shutdown() call will deadlock."

----------
assignee: georg.brandl
components: Documentation
messages: 87845
nosy: gagenellina, georg.brandl
severity: normal
status: open
title: BaseServer.shutdown documentation is incomplete
type: behavior
versions: Python 2.6, Python 2.7, Python 3.0, Python 3.1, Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue6031>
_______________________________________