classification
Title: Remove Tulip words from asyncio documentation/code
Type: enhancement Stage:
Components: Documentation Versions: Python 3.4
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, gvanrossum, vajrasky, vstinner
Priority: normal Keywords: patch

Created on 2013-12-13 09:54 by vajrasky, last changed 2013-12-13 09:59 by vstinner. This issue is now closed.

Files
File name Uploaded Description Edit
remove_Tulip.patch vajrasky, 2013-12-13 09:54 review
Messages (2)
msg206036 - (view) Author: Vajrasky Kok (vajrasky) * Date: 2013-12-13 09:54
I was reading the documentation about asyncio. Here is the introduction paragraph:

Doc/library/asyncio.rst
=======================

This module provides infrastructure for writing single-threaded concurrent
code using coroutines, multiplexing I/O access over sockets and other
resources, running network clients and servers, and other related primitives.
Here is a more detailed list of the package contents:

Then I read it like a novel. Then somewhere out of the blue, the Tulip word shows up.

Doc/library/asyncio-sync.rst
============================

Unlike the standard library :mod:`queue`, you can reliably know this Queue's
   size with :meth:`qsize`, since your single-threaded Tulip application won't
   be interrupted between calling :meth:`qsize` and doing an operation on the
   Queue.

The Tulip word breaks the flow of the story because we never introduce the Tulip word previously. There are two ways to handle this situation:
1. Introduce the Tulip word in the introduction and other parts consistently,
2. Remove the references to Tulip.

I suggest we take option 2 (users of Python 3.4 asyncio stdlib have no reason to know the word Tulip). Here is the patch.
msg206037 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2013-12-13 09:59
I agree to drop references to the Tulip name. Thanks for your patch.

changeset:   87927:10378199e37b
tag:         tip
user:        Victor Stinner <victor.stinner@gmail.com>
date:        Fri Dec 13 10:57:04 2013 +0100
files:       Doc/library/asyncio-sync.rst Doc/whatsnew/3.4.rst Lib/asyncio/queues.py Lib/asyncio/test_utils.py
description:
asyncio: remove references to the Tulip project, rename Tulip to asyncio.
Patch written by Vajrasky Kok.
History
Date User Action Args
2013-12-13 09:59:19vstinnersetstatus: open -> closed

nosy: + vstinner
messages: + msg206037

resolution: fixed
2013-12-13 09:54:49vajraskycreate