openstack/deb-python-happybase
Code Issues Proposed changes

Use 'user guide' instead of 'tutorial' in docs

Browse Source
This commit is contained in:
Wouter Bolsterlee
2013-05-24 12:18:40 +02:00
parent ae8fee1715
commit b8087aaf74
3 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/api.rst
View File

@@ -5,7 +5,7 @@ API reference
.. py:currentmodule:: happybase .. py:currentmodule:: happybase
This chapter contains detailed API documentation for HappyBase. It is suggested This chapter contains detailed API documentation for HappyBase. It is suggested
to read the :doc:`tutorial <tutorial>` first to get a general idea about how to read the :doc:`user guide <user>` first to get a general idea about how
HappyBase works. HappyBase works.
The HappyBase API is organised as follows: The HappyBase API is organised as follows:

2
doc/installation.rst
View File

@@ -56,7 +56,7 @@ If you don't see any errors, the installation was successful. Congratulations!
.. rubric:: Next steps .. rubric:: Next steps
Now that you successfully installed HappyBase on your machine, continue with Now that you successfully installed HappyBase on your machine, continue with
the :doc:`tutorial <tutorial>` to learn how to use it. the :doc:`user guide <user>` to learn how to use it.
.. vim: set spell spelllang=en: .. vim: set spell spelllang=en:

16
doc/user.rst
View File

@@ -4,12 +4,12 @@ User guide
.. py:currentmodule:: happybase .. py:currentmodule:: happybase
This tutorial explores the HappyBase API and should provide you with enough This user guide explores the HappyBase API and should provide you with enough
information to get you started. Note that this tutorial is intended as an information to get you started. Note that this user guide is intended as an
introduction to HappyBase, not to HBase in general. Readers should already have introduction to HappyBase, not to HBase in general. Readers should already have
a basic understanding of HBase and its data model. a basic understanding of HBase and its data model.
While the tutorial does cover most features, it is not a complete reference While the user guide does cover most features, it is not a complete reference
guide. More information about the HappyBase API is available from the :doc:`API guide. More information about the HappyBase API is available from the :doc:`API
documentation <api>`. documentation <api>`.
@@ -55,8 +55,8 @@ HBase. For instance, to list the available tables, use
Most other methods on the :py:class:`Connection` class are intended for system Most other methods on the :py:class:`Connection` class are intended for system
management tasks like creating, dropping, enabling and disabling tables. See the management tasks like creating, dropping, enabling and disabling tables. See the
:doc:`API documentation <api>` for the :py:class:`Connection` class contains :doc:`API documentation <api>` for the :py:class:`Connection` class contains
more information. This tutorial does not cover those since it's more likely you more information. This user guide does not cover those since it's more likely
are already using the HBase shell for these system management tasks. you are already using the HBase shell for these system management tasks.
Working with tables Working with tables
@@ -91,8 +91,8 @@ Thrift server, which means application code may ask the :py:class:`Connection`
instance for a new :py:class:`Table` whenever it needs one, without negative instance for a new :py:class:`Table` whenever it needs one, without negative
performance consequences. A side effect is that no check is done to ensure that performance consequences. A side effect is that no check is done to ensure that
the table exists, since that would involve a round-trip. Expect errors if you the table exists, since that would involve a round-trip. Expect errors if you
try to interact with non-existing tables later in your code. For this tutorial, try to interact with non-existing tables later in your code. For this guide, we
we assume the table exists. assume the table exists.
.. note:: .. note::
@@ -465,7 +465,7 @@ methods can be used to retrieve or set a counter value directly::
.. rubric:: Next steps .. rubric:: Next steps
The next step is to try it out for yourself. The :doc:`API documentation <api>` The next step is to try it out for yourself! The :doc:`API documentation <api>`
can be used as a reference. can be used as a reference.
.. vim: set spell spelllang=en: .. vim: set spell spelllang=en: