[SciPy-user] from scipy import * -- was: [Scipy-tickets] #635: update the old scipy tutorial and re-release it

[Sebastian Haase]

Hi all,
I just got the mentioned scipy ticket emailed, which triggered this email:

Isn't the official guideline always "don't use  >>> from ... import *  " ?
Why are tutorial often written with  introducing sentences like this:
"""Throughout this tutorial it is assumed that the user has imported
all of the names defined in the SciPy top-level namespace using the
command
    >>> from scipy import *
"""
???

I would argue that for two reasons this should be changed:
1) Especially tutorials should lead by example and show any newcomer
how to do it "right" - and therefore start with
 """>>> import scipy as sp""" instead.
2) It would be much easier to spot which commands / types / functions
come from scipy and which are standard python built ins or from the
py standard lib.

It would be nice to hear if others also feel (somewhat) strongly about this ....

Cheers,
Sebastian Haase

Forwarded conversation
Subject: Re: [Scipy-tickets] [SciPy] #635: update the old scipy
tutorial and re-release it
------------------------

From: SciPy <scipy-tickets at scipy.org>
Date: Sun, Nov 30, 2008 at 2:11 AM
To:
Cc: scipy-tickets at scipy.org


#635: update the old scipy tutorial and re-release it
-------------------------+--------------------------------------------------
 Reporter:  AndrewStraw  |        Owner:  somebody
    Type:  enhancement  |       Status:  new
 Priority:  low          |    Milestone:  0.7.0
Component:  Other        |      Version:
 Severity:  normal       |   Resolution:
 Keywords:               |
-------------------------+--------------------------------------------------
Changes (by pv):

 * milestone:  => 0.7.0

Comment:

 This is nearly done; cf.

    http://docs.scipy.org/scipy/docs/scipy-docs/tutorial/index.rst/

--
Ticket URL: <http://scipy.org/scipy/scipy/ticket/635#comment:1>
SciPy <http://www.scipy.org/>
SciPy is open-source software for mathematics, science, and engineering.
_______________________________________________
Scipy-tickets mailing list
Scipy-tickets at scipy.org
http://projects.scipy.org/mailman/listinfo/scipy-tickets

----------
From: SciPy <scipy-tickets at scipy.org>
Date: Sun, Dec 7, 2008 at 6:21 PM
To:
Cc: scipy-tickets at scipy.org


    Type:  enhancement  |       Status:  closed
 Severity:  normal       |   Resolution:  fixed
 Keywords:               |
-------------------------+--------------------------------------------------
Changes (by pv):

 * status:  new => closed
 * resolution:  => fixed

Comment:

 The tutorial is now up-to-date.

--
Ticket URL: <http://scipy.org/scipy/scipy/ticket/635#comment:2>