summaryrefslogtreecommitdiffstats
path: root/user_guide_src
diff options
context:
space:
mode:
authorAndrey Andreev <narf@devilix.net>2014-11-25 18:04:50 +0100
committerAndrey Andreev <narf@devilix.net>2014-11-25 18:04:50 +0100
commit2c15932596d2cdf0953ebdc34fbc3a204896d27a (patch)
treefa1087782fea10433e5f8c687d5d8780aa1975d9 /user_guide_src
parent809a1b516d4760fe631f8d3ffa767b9f9310dacc (diff)
parent8a474f83a56eafb5c6f632f15dff50265b838290 (diff)
Merge pull request #3371 from jim-parry/userguide/contributing
User Guide update - Contributing
Diffstat (limited to 'user_guide_src')
-rw-r--r--user_guide_src/source/documentation/index.rst18
-rw-r--r--user_guide_src/source/index.rst2
2 files changed, 10 insertions, 10 deletions
diff --git a/user_guide_src/source/documentation/index.rst b/user_guide_src/source/documentation/index.rst
index 38124f7f2..6d4c94bc1 100644
--- a/user_guide_src/source/documentation/index.rst
+++ b/user_guide_src/source/documentation/index.rst
@@ -5,11 +5,11 @@ Writing CodeIgniter Documentation
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 @@ Method Documentation
********************
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 @@ ReST:
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 @@ ReST:
.. 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 @@ It creates the following display:
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 @@ It creates the following display:
.. 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 56ce619ce..d8f60e360 100644
--- a/user_guide_src/source/index.rst
+++ b/user_guide_src/source/index.rst
@@ -101,6 +101,7 @@ Contributing to CodeIgniter
:titlesonly:
contributing/index
+ documentation/index
DCO
.. toctree::
@@ -117,6 +118,5 @@ Contributing to CodeIgniter
libraries/index
helpers/index
database/index
- documentation/index
tutorial/index
general/credits