From b8087aaf747663317d533437ca5b42f5c93e9f02 Mon Sep 17 00:00:00 2001 From: Wouter Bolsterlee Date: Fri, 24 May 2013 12:18:40 +0200 Subject: [PATCH] Use 'user guide' instead of 'tutorial' in docs --- doc/api.rst | 2 +- doc/installation.rst | 2 +- doc/user.rst | 16 ++++++++-------- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/api.rst b/doc/api.rst index c661d3c..2b1e3b7 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -5,7 +5,7 @@ API reference .. py:currentmodule:: happybase This chapter contains detailed API documentation for HappyBase. It is suggested -to read the :doc:`tutorial ` first to get a general idea about how +to read the :doc:`user guide ` first to get a general idea about how HappyBase works. The HappyBase API is organised as follows: diff --git a/doc/installation.rst b/doc/installation.rst index 7c0446a..e575488 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -56,7 +56,7 @@ If you don't see any errors, the installation was successful. Congratulations! .. rubric:: Next steps Now that you successfully installed HappyBase on your machine, continue with -the :doc:`tutorial ` to learn how to use it. +the :doc:`user guide ` to learn how to use it. .. vim: set spell spelllang=en: diff --git a/doc/user.rst b/doc/user.rst index 1685180..9e40bee 100644 --- a/doc/user.rst +++ b/doc/user.rst @@ -4,12 +4,12 @@ User guide .. py:currentmodule:: happybase -This tutorial explores the HappyBase API and should provide you with enough -information to get you started. Note that this tutorial is intended as an +This user guide explores the HappyBase API and should provide you with enough +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 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 documentation `. @@ -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 management tasks like creating, dropping, enabling and disabling tables. See the :doc:`API documentation ` for the :py:class:`Connection` class contains -more information. This tutorial does not cover those since it's more likely you -are already using the HBase shell for these system management tasks. +more information. This user guide does not cover those since it's more likely +you are already using the HBase shell for these system management tasks. 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 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 -try to interact with non-existing tables later in your code. For this tutorial, -we assume the table exists. +try to interact with non-existing tables later in your code. For this guide, we +assume the table exists. .. note:: @@ -465,7 +465,7 @@ methods can be used to retrieve or set a counter value directly:: .. rubric:: Next steps -The next step is to try it out for yourself. The :doc:`API documentation ` +The next step is to try it out for yourself! The :doc:`API documentation ` can be used as a reference. .. vim: set spell spelllang=en: