[NumPy-Tickets] [NumPy] #1072: Example conventions should be clarified in reference guide

NumPy Trac numpy-tickets@scipy....
Tue Feb 9 08:57:41 CST 2010


#1072: Example conventions should be clarified in reference guide
---------------------------+------------------------------------------------
 Reporter:  dlary          |       Owner:  pv          
     Type:  defect         |      Status:  needs_review
 Priority:  normal         |   Milestone:              
Component:  Documentation  |     Version:              
 Keywords:                 |  
---------------------------+------------------------------------------------
Changes (by rgommers):

  * status:  new => needs_review


Comment:

 Added the following to routines.rst in the doc wiki:
 {{{
 In this chapter routine docstrings are presented, grouped by
 functionality.
 Many docstrings contain example code, which demonstrates basic usage
 of the routine. The examples assume that NumPy is imported with::

   >>> import numpy as np

 A convenient way to execute examples is the ``%doctest_mode`` mode of
 IPython, which allows for pasting of multi-line examples and preserves
 indentation.
 }}}
 Feel free to move it, but at least the assumption is mentioned now in a
 sensible place.

-- 
Ticket URL: <http://projects.scipy.org/numpy/ticket/1072#comment:2>
NumPy <http://projects.scipy.org/numpy>
My example project


More information about the NumPy-Tickets mailing list