minor edits
authorRobert Bradshaw <robertwb@math.washington.edu>
Thu, 12 Nov 2009 07:46:16 +0000 (23:46 -0800)
committerRobert Bradshaw <robertwb@math.washington.edu>
Thu, 12 Nov 2009 07:46:16 +0000 (23:46 -0800)
--HG--
rename : src/tutorial/sage.png => src/quickstart/sage.png

src/quickstart/build.rst
src/quickstart/index.rst
src/quickstart/sage.png [moved from src/tutorial/sage.png with 100% similarity]
src/reference/language_basics.rst
src/tutorial/index.rst

index 783d29879f90e2fc30a7a10a8a83e793b99d7e3b..770c8ed4404f3d154cb838b0763d285bbd45ddf2 100644 (file)
@@ -20,7 +20,7 @@ There are several ways to build Cython code:
    (This is mostly for debugging and experimentation.)
  - Use the [Sage]_ notebook which allows Cython code inline.
 
-Currently, distutils is the most common way Cython files are built and distributed. 
+Currently, distutils is the most common way Cython files are built and distributed. The other methods are described in more detail in the :doc:`../reference/compilation` section of the reference manual.
 
 Building a Cython module using distutils
 ----------------------------------------
@@ -48,6 +48,8 @@ To build, run ``python setup.py build_ext --inplace``.  Then simply
 start a Python session and do ``from hello import say_hello_to`` and
 use the imported function as you see fit.
 
+
+
 .. figure:: sage.png
 
   The Sage notebook allows transparently editing and compiling Cython
index 6aaa3d06868d12ef8117c8fcaab372070c5ff368..3f2c439859e176c4e9f21eb489ebd3feb23e025a 100644 (file)
@@ -7,6 +7,4 @@ Getting Started
    overview
    install
    build
-   datatypes
    cythonize
-   cdef_functions
index e086f48d49e757976d88c095800ecb412e5b83ad..d9d2e93f53aea52112811c2b9d63f78ee9cc5ec9 100644 (file)
@@ -14,11 +14,26 @@ Cython File Types
 
 There are three file types in cython:
 
-* Definition files carry a ``.pxd`` suffix
 * Implementation files carry a ``.pyx`` suffix
+* Definition files carry a ``.pxd`` suffix
 * Include files which carry a ``.pxi`` suffix
 
 
+Implementation File
+===================
+
+What can it contain?
+--------------------
+
+* Basically anything Cythonic, but see below.
+
+What can't it contain?
+----------------------
+
+* There are some restrictions when it comes to **extension types**, if the extension type is
+  already defined else where... **more on this later**
+
+
 Definition File
 ===============
 
@@ -52,7 +67,7 @@ cimport
 * Use the **cimport** statement, as you would Python's import statement, to access these files
   from other definition or implementation files.
 * **cimport** does not need to be called in ``.pyx`` file for for ``.pxd`` file that has the
-  same name. This is automatic.
+  same name, as they are already in the same namespace.
 * For cimport to find the stated definition file, the path to the file must be appended to the
   ``-I`` option of the **cython compile command**.
 
@@ -64,21 +79,6 @@ compilation order
 
 
 
-Implementation File
-===================
-
-What can it contain?
---------------------
-
-* Basically anything Cythonic, but see below.
-
-What can't it contain?
-----------------------
-
-* There are some restrictions when it comes to **extension types**, if the extension type is
-  already defined else where... **more on this later**
-
-
 Include File
 ============
 
@@ -101,12 +101,10 @@ How do I use it?
 Declaring Data Types
 ====================
 
-.. note::
-    .. todo:: Remove paragragh
 
 As a dynamic language, Python encourages a programming style of considering classes and objects in terms of their methods and attributes, more than where they fit into the class hierarchy.
 
-This can make Python a very relaxed and comfortable language for rapid development, but with a price - the ‘red tape’ of managing data types is dumped onto the interpreter. At run time, the interpreter does a lot of work searching namespaces, fetching attributes and parsing argument and keyword tuples. This run-time ‘late binding’ is a major cause of Python’s relative slowness compared to ‘early binding’ languages such as C++.
+This can make Python a very relaxed and comfortable language for rapid development, but with a price - the 'red tape' of managing data types is dumped onto the interpreter. At run time, the interpreter does a lot of work searching namespaces, fetching attributes and parsing argument and keyword tuples. This run-time ‘late binding’ is a major cause of Python’s relative slowness compared to ‘early binding’ languages such as C++.
 
 However with Cython it is possible to gain significant speed-ups through the use of ‘early binding’ programming techniques.
 
@@ -288,14 +286,14 @@ Optional Arguments
         cpdef foo(self, x=*, int k=*)
 
 
-  * The number of arguments may increase when subclassing, buty the arg types and order must be the same.
+  * The number of arguments may increase when subclassing, but the arg types and order must be the same.
 
 * There may be a slight performance penalty when the optional arg is overridden with one that does not have default values.
 
 Keyword-only Arguments
 =======================
 
-* ``def`` functions can have keyword-only argurments listed after a ``"*"`` parameter and before a ``"**"`` parameter if any::
+* As in Python 3, ``def`` functions can have keyword-only argurments listed after a ``"*"`` parameter and before a ``"**"`` parameter if any::
 
     def f(a, b, *args, c, d = 42, e, **kwds):
         ...
@@ -317,7 +315,7 @@ Automatic Type Conversion
 
 * For basic numeric and string types, in most situations, when a Python object is used in the context of a C value and vice versa.
 
-* The following table summarises the conversion possibilities:
+* The following table summarises the conversion possibilities, assuming ``sizeof(int) == sizeof(long)``:
 
     +----------------------------+--------------------+------------------+
     | C types                    | From Python types  | To Python types  |
@@ -506,7 +504,7 @@ For-loops
         ...
 
 * The ``break`` and ``continue`` are permissible.
-* Can contain an if-else clause.
+* Can contain an else clause.
 
 =====================
 Functions and Methods
index b7b8e6e2e0014b75629bee3178fab5d2b231beba..a516011546931fb4c4b8f22f2af4bfa43ab695b7 100644 (file)
@@ -18,10 +18,3 @@ Contents:
    related_work
    appendix
 
-
-Indices and tables
-------------------
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`