DOC: mostly finished with doc updates

Author: wesm

TODO.rst

@@ -37,10 +37,9 @@ TODO docs
 - DONE name attribute on Series
 - DONE Multi-key joining
 - DONE Inner join on key
-
-- align functions
-- df[col_list]
-- Panel.rename_axis
+- DONE align functions
+- DONE df[col_list]
+- DONE Panel.rename_axis
 
 Performance blog
 ----------------

doc/source/api.rst

@@ -5,6 +5,88 @@
 API Reference
 *************
 
+.. _api.functions:
+
+General functions
+-----------------
+
+Data manipulations
+~~~~~~~~~~~~~~~~~~
+.. currentmodule:: pandas.tools.pivot
+
+.. autosummary::
+   :toctree: generated/
+
+   pivot_table
+
+Pickling
+~~~~~~~~
+
+.. currentmodule:: pandas.core.common
+
+.. autosummary::
+   :toctree: generated/
+
+   load
+   save
+
+File IO
+~~~~~~~
+
+.. currentmodule:: pandas.io.parsers
+
+.. autosummary::
+   :toctree: generated/
+
+   read_table
+   read_csv
+   ExcelFile.parse
+
+HDFStore: PyTables (HDF5)
+~~~~~~~~~~~~~~~~~~~~~~~~~
+.. currentmodule:: pandas.io.pytables
+
+.. autosummary::
+   :toctree: generated/
+
+   HDFStore.put
+   HDFStore.get
+
+Standard moving window functions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. currentmodule:: pandas.stats.moments
+
+.. autosummary::
+   :toctree: generated/
+
+   rolling_count
+   rolling_sum
+   rolling_mean
+   rolling_median
+   rolling_var
+   rolling_std
+   rolling_corr
+   rolling_cov
+   rolling_skew
+   rolling_kurt
+   rolling_apply
+   rolling_quantile
+
+Exponentially-weighted moving window functions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autosummary::
+   :toctree: generated/
+
+   ewma
+   ewmstd
+   ewmvar
+   ewmcorr
+   ewmcov
+
+.. currentmodule:: pandas
+
 .. _api.series:
 
 Series
@@ -20,6 +102,8 @@ Attributes and underlying data
 
    Series.values
    Series.dtype
+   Series.isnull
+   Series.notnull
 
 Conversion / Constructors
 ~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -89,12 +173,14 @@ Computations / Descriptive Stats
    Series.std
    Series.sum
    Series.var
+   Series.value_counts
 
 Reindexing / Selection / Label manipulation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 .. autosummary::
    :toctree: generated/
 
+   Series.align
    Series.drop
    Series.reindex
    Series.reindex_like
@@ -178,6 +264,8 @@ Attributes and underlying data
    :toctree: generated/
 
    DataFrame.as_matrix
+   DataFrame.dtypes
+   DataFrame.get_dtype_counts
    DataFrame.values
    DataFrame.axes
    DataFrame.ndim
@@ -267,6 +355,7 @@ Reindexing / Selection / Label manipulation
 
    DataFrame.add_prefix
    DataFrame.add_suffix
+   DataFrame.align
    DataFrame.drop
    DataFrame.filter
    DataFrame.reindex
@@ -355,75 +444,3 @@ Panel
 Computations / Descriptive Stats
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-
-Input / Output
---------------
-
-.. currentmodule:: pandas.io.parsers
-
-File IO
-~~~~~~~
-
-.. autosummary::
-   :toctree: generated/
-
-   read_table
-   read_csv
-   ExcelFile.parse
-
-HDFStore: PyTables (HDF5)
-~~~~~~~~~~~~~~~~~~~~~~~~~
-.. currentmodule:: pandas.io.pytables
-
-.. autosummary::
-   :toctree: generated/
-
-   HDFStore.put
-   HDFStore.get
-
-GroupBy
--------
-
-.. currentmodule:: pandas.core.groupby
-
-.. autosummary::
-   :toctree: generated/
-
-   groupby
-
-Moving window statistics
-------------------------
-
-Standard moving window functions
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. currentmodule:: pandas.stats.moments
-
-.. autosummary::
-   :toctree: generated/
-
-   rolling_count
-   rolling_sum
-   rolling_mean
-   rolling_median
-   rolling_var
-   rolling_std
-   rolling_corr
-   rolling_cov
-   rolling_skew
-   rolling_kurt
-   rolling_apply
-   rolling_quantile
-
-Exponentially-weighted moving window functions
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. autosummary::
-   :toctree: generated/
-
-   ewma
-   ewmstd
-   ewmvar
-   ewmcorr
-   ewmcov
-

doc/source/basics.rst

@@ -467,7 +467,7 @@ Reindexing to align with another object
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 You may wish to take an object and reindex its axes to be labeled the same as
-another object. While the syntax for this is straightforwad albeit verbose, it
+another object. While the syntax for this is straightforward albeit verbose, it
 is a common enough operation that the ``reindex_like`` method is available to
 make this simpler:
 
@@ -484,6 +484,36 @@ make this simpler:
    df2
    df.reindex_like(df2)
 
+.. _basics.align:
+
+Aligning objects with each other with ``align``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The ``align`` method is the fastest way to simultaneously align two objects. It
+supports a ``join`` argument (related to :ref:`joining and merging <merging>`):
+
+  - ``join='outer'``: take the union of the indexes
+  - ``join='left'``: use the calling object's index
+  - ``join='right'``: use the passed object's index
+  - ``join='inner'``: intersect the indexes
+
+It returns a tuple with both of the reindexed Series:
+
+.. ipython:: python
+
+   s = Series(randn(5), index=['a', 'b', 'c', 'd', 'e'])
+   s1 = s[:4]
+   s2 = s[1:]
+   s1.align(s2)
+   s1.align(s2, join='inner')
+   s1.align(s2, join='left')
+
+For DataFrames, the join method will be applied to both the
+
+.. ipython:: python
+
+   df.align(df2, join='inner')
+
 .. _basics.reindex_fill:
 
 Filling while reindexing
@@ -573,6 +603,9 @@ Series, it need only contain a subset of the labels as keys:
    df.rename(columns={'one' : 'foo', 'two' : 'bar'},
              index={'a' : 'apple', 'b' : 'banana', 'd' : 'durian'})
 
+The Panel class has an a related ``rename_axis`` class which can rename any of
+its three axes.
+
 Iteration
 ---------
 

doc/source/indexing.rst

@@ -187,6 +187,17 @@ As we will see later on, the same operation could be accomplished by
 reindexing. However, the syntax would be more verbose; hence, the inclusion of
 this indexing method.
 
+Selecting DataFrame columns
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+You can pass a list of columns to ``[]`` to select columns in that order:
+
+.. ipython:: python
+
+   df[['C', 'A', 'B']]
+
+If a column is not contained in the DataFrame, an exception will be raised:
+
 .. _indexing.advanced:
 
 Advanced indexing with labels