Merge pull request #3371 from jim-parry/userguide/contributing
User Guide update - Contributing
diff --git a/user_guide_src/source/documentation/index.rst b/user_guide_src/source/documentation/index.rst
index 38124f7..6d4c94b 100644
--- a/user_guide_src/source/documentation/index.rst
+++ b/user_guide_src/source/documentation/index.rst
@@ -5,11 +5,11 @@
CodeIgniter uses Sphinx to generate its documentation in a variety of formats,
using reStructuredText to handle the formatting. If you are familiar with
Markdown or Textile, you will quickly grasp reStructuredText. The focus is
-on readability, user friendliness, and an "I've got your hand, baby" feel.
+on readability and user friendliness.
While they can be quite technical, we always write for humans!
-A local table of contents should always be included like the one below.
-It is created automatically by inserting the the following:
+A local table of contents should always be included, like the one below.
+It is created automatically by inserting the following:
::
@@ -110,8 +110,8 @@
********************
When documenting class methods for third party developers, Sphinx provides
-directives to assist and keep things simple. For example, consider the following
-ReST:
+directives to assist and keep things simple.
+For example, consider the following ReST:
.. code-block:: rst
@@ -124,7 +124,7 @@
parameter.
:param int $foo: the foo id to do something in
- :param mixed $bar: A data array that must contain aa something and something else
+ :param mixed $bar: A data array that must contain a something and something else
:param bool $bat: whether or not to do something
:returns: FALSE on failure, TRUE if successful
:rtype: bool
@@ -153,7 +153,7 @@
.. method:: should_do_something()
- :returns: Whether or something should be done or not
+ :returns: Whether or not something should be done
:rtype: bool
@@ -169,7 +169,7 @@
parameter.
:param int $foo: the foo id to do something in
- :param mixed $bar: A data array that must contain aa something and something else
+ :param mixed $bar: A data array that must contain a something and something else
:param bool $bat: whether or not to do something
:returns: FALSE on failure, TRUE if successful
:rtype: bool
@@ -198,5 +198,5 @@
.. method:: should_do_something()
- :returns: Whether or something should be done or not
+ :returns: Whether or not something should be done
:rtype: bool
\ No newline at end of file
diff --git a/user_guide_src/source/index.rst b/user_guide_src/source/index.rst
index 56ce619..d8f60e3 100644
--- a/user_guide_src/source/index.rst
+++ b/user_guide_src/source/index.rst
@@ -101,6 +101,7 @@
:titlesonly:
contributing/index
+ documentation/index
DCO
.. toctree::
@@ -117,6 +118,5 @@
libraries/index
helpers/index
database/index
- documentation/index
tutorial/index
general/credits