Skip to content

Commit

Permalink
Revert "updated utils docs to better reflect reality" - it was premat…
Browse files Browse the repository at this point in the history
…urely commited

This reverts commit d344832.
  • Loading branch information
eteq committed Nov 6, 2012
1 parent d344832 commit 36235b3
Showing 1 changed file with 11 additions and 18 deletions.
29 changes: 11 additions & 18 deletions docs/utils/index.rst
Expand Up @@ -7,18 +7,17 @@ Astropy Core Package Utilities (`astropy.utils`)
Introduction
============

The `astropy.utils` package contains general-purpose utility functions and
classes. Examples include data structures, tools for downloading and caching
from URLs, and version intercompatibility functions.

This functionality is not astronomy-specific, but is intended primarily for
use by Astropy developers. It is all safe for users to use, but the functions
and classes are typically more complicated or specific to a particuly need of
Astropy.

Because of the mostly standalone and grab-bag nature of these utilities, they
are generally best understood through their docstrings, and hence this
documentation does not have detailed sections like the other packages.
The `astropy.utils` package contains general-purpose utilities
functions and classes that such as general-purpose data structures,
version intercompatibility functions. Basically, if it's not
astronomy-related, but likely useful for other developers, it probably
lives here. These are safe for users to make use of, but they are
typically more complicated or esoteric enough that they are mostly of
interest to developers.

Because of the mostly standalone and grab-bag nature of these utilities,
they are generally best understood through their docstrings, and hence
only the reference section is currently provided for this subpackage.

.. note::
The `astropy.utils.compat` subpackage is not included in this
Expand All @@ -42,12 +41,6 @@ Reference/API
.. automodapi:: astropy.utils.console
:no-inheritance-diagram:

File Downloads
--------------

.. automodapi:: astropy.utils.data
:no-inheritance-diagram:

XML
---
The ``astropy.utils.xml.*`` modules provide various
Expand Down

0 comments on commit 36235b3

Please sign in to comment.