Skip to content
This repository has been archived by the owner on Jun 17, 2023. It is now read-only.

Commit

Permalink
Move tutorial-ish above API docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
hynek committed Aug 5, 2014
1 parent 980d7ce commit 208ec50
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ Then there's the helper ``@attributes`` that combines them all into one decorato
Generally the decorators take a list of attributes as their first positional argument.
This list can consists of either native strings\ [*]_ for simple cases or instances of :class:`Attribute` that allow for more customization of ``characteristics`` behavior.

The easiest way to get started is to have a look at the :doc:`examples` to get a feeling for `characteristic`` and return later for details!

.. [*] Byte strings on Python 2 and Unicode strings on Python 3.
.. autofunction:: attributes

See :doc:`examples` for ``@attributes`` in action!


.. autofunction:: with_repr

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ User's Guide
:maxdepth: 1

why
api
examples
api

Project Information
^^^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit 208ec50

Please sign in to comment.