.. _overview:

Code Overview
=============

Here you will find an overview of PRAW's objects and methods, but not the
objects attributes who are generated dynamically from reddit's responses and
are thus impossible to accurately describe statically. In :ref:`writing_a_bot`
there is a longer discussion of how to introspect PRAW, which you can use in
conjunction with this nice visual overview.

:mod:`praw` Package
-------------------

.. automodule:: praw.__init__
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`objects` Module
---------------------

.. automodule:: praw.objects
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`helpers` Module
---------------------

.. automodule:: praw.helpers
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`errors` Module
--------------------

.. automodule:: praw.errors
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`handlers` Module
----------------------

.. automodule:: praw.handlers
    :members:
    :undoc-members:
    :show-inheritance:


:mod:`decorators` Module
------------------------

.. automodule:: praw.decorators
    :members:
    :undoc-members:
    :show-inheritance:


:mod:`internal` Module
----------------------

.. automodule:: praw.internal
    :members:
    :undoc-members:
    :show-inheritance:

.. _overview:

Code Overview
=============

Here you will find an overview of PRAW's objects and methods, but not the
objects attributes who are generated dynamically from reddit's responses and
are thus impossible to accurately describe statically. In :ref:`writing_a_bot`
there is a longer discussion of how to introspect PRAW, which you can use in
conjunction with this nice visual overview.

:mod:`praw` Package
-------------------

.. automodule:: praw.__init__
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`objects` Module
---------------------

.. automodule:: praw.objects
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`helpers` Module
---------------------

.. automodule:: praw.helpers
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`errors` Module
--------------------

.. automodule:: praw.errors
    :members:
    :undoc-members:
    :show-inheritance:

:mod:`handlers` Module
----------------------

.. automodule:: praw.handlers
    :members:
    :undoc-members:
    :show-inheritance:


:mod:`decorators` Module
------------------------

.. automodule:: praw.decorators
    :members:
    :undoc-members:
    :show-inheritance:

Remove 'internal' module from code overview.
Remove 'internal' module from code overview.

It is strictly for internal use and the methods inside it are not
part of the official API. If people want to use them they are free
to do so, but we should not include it in the docuementation.
