summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGreg Aker <greg@gregaker.net>2011-12-26 05:27:59 +0100
committerGreg Aker <greg@gregaker.net>2011-12-26 05:27:59 +0100
commitffd24a467c1d5ad6e2e4b66b63d4c9248f961b1e (patch)
treebcd258975164aeda9f4f9793b82e16798defd3cd
parenta96ade374f28cdae97036fc253fd8b2a0e8dc81a (diff)
Fixing a couple of issues in documentation files that occur when running Sphinx 'make html'
-rw-r--r--user_guide_src/source/database/active_record.rst15
-rw-r--r--user_guide_src/source/database/configuration.rst1
-rw-r--r--user_guide_src/source/libraries/cart.rst10
3 files changed, 12 insertions, 14 deletions
diff --git a/user_guide_src/source/database/active_record.rst b/user_guide_src/source/database/active_record.rst
index 228d1d509..1600f0bd9 100644
--- a/user_guide_src/source/database/active_record.rst
+++ b/user_guide_src/source/database/active_record.rst
@@ -82,7 +82,7 @@ The key thing to notice in the above example is that the second query did not
utilize `$this->db->from()`_ and did not pass a table name into the first
parameter. The reason for this outcome is because the query has not been
executed using `$this->db->get()`_ which resets values or reset directly
-using `$this-db->reset_query()`_.
+using `$this->db->reset_query()`_.
$this->db->get_where()
@@ -96,8 +96,7 @@ function::
Please read the about the where function below for more information.
-.. note:: get_where() was formerly known as getwhere(), which has been
-removed
+.. note:: get_where() was formerly known as getwhere(), which has been removed
$this->db->select()
===================
@@ -789,7 +788,7 @@ $this->db->get_compiled_update()
This works exactly the same way as ``$this->db->get_compiled_insert()`` except
that it produces an UPDATE SQL string instead of an INSERT SQL string.
-For more information view documentation for `$this->get_compiled_insert()`_.
+For more information view documentation for `$this->db->get_compiled_insert()`_.
*************
@@ -864,7 +863,7 @@ $this->db->get_compiled_delete()
This works exactly the same way as ``$this->db->get_compiled_insert()`` except
that it produces a DELETE SQL string instead of an INSERT SQL string.
-For more information view documentation for `$this->get_compiled_insert()`_.
+For more information view documentation for `$this->db->get_compiled_insert()`_.
***************
Method Chaining
@@ -933,10 +932,8 @@ Here's a usage example::
where, like, group_by, having, order_by, set
-
-*******************
-Reset Active Record
-*******************
+$this->db->reset_query()
+========================
Resetting Active Record allows you to start fresh with your query without
executing it first using a method like $this->db->get() or $this->db->insert().
diff --git a/user_guide_src/source/database/configuration.rst b/user_guide_src/source/database/configuration.rst
index 433c67152..4f88c25ab 100644
--- a/user_guide_src/source/database/configuration.rst
+++ b/user_guide_src/source/database/configuration.rst
@@ -158,6 +158,7 @@ Explanation of Values:
while developing an application.
**port** The database port number. To use this value you have to add a line to the database config array.
::
+
$db['default']['port'] = 5432;
====================== ==================================================================================================
diff --git a/user_guide_src/source/libraries/cart.rst b/user_guide_src/source/libraries/cart.rst
index fbf777884..6594b3b9a 100644
--- a/user_guide_src/source/libraries/cart.rst
+++ b/user_guide_src/source/libraries/cart.rst
@@ -257,7 +257,7 @@ $this->cart->update();
Permits you to update items in the shopping cart, as outlined above.
$this->cart->remove(rowid);
-**********************
+***************************
Allows you to remove an item from the shopping cart by passing it the rowid.
@@ -267,12 +267,12 @@ $this->cart->total();
Displays the total amount in the cart.
$this->cart->total_items();
-****************************
+***************************
Displays the total number of items in the cart.
$this->cart->contents(boolean);
-************************
+*******************************
Returns an array containing everything in the cart. You can sort the order,
by which this is returned by passing it "true" where the contents will be sorted
@@ -280,7 +280,7 @@ from newest to oldest, by leaving this function blank, you'll automatically just
first added to the basket to last added to the basket.
$this->cart->has_options(rowid);
-*********************************
+********************************
Returns TRUE (boolean) if a particular row in the cart contains options.
This function is designed to be used in a loop with
@@ -288,7 +288,7 @@ $this->cart->contents(), since you must pass the rowid to this function,
as shown in the Displaying the Cart example above.
$this->cart->product_options(rowid);
-*************************************
+************************************
Returns an array of options for a particular product. This function is
designed to be used in a loop with $this->cart->contents(), since you