summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-09-02 07:25:26 -0700
committerwww-data <www-data@enlightenment.org>2019-09-02 07:25:26 -0700
commit8e7f72e4dc8e1f3a32d6afb598548f1e62731957 (patch)
tree146ec831d1f827bf00a84483c3ec4ce5068c7362
parent260ce41e7119e65ccfb7fdc8200e870be826a364 (diff)
Wiki page eo-guide.md changed with summary [changed maximum line length] by Xavi Artigas
-rw-r--r--pages/contrib/docs/eo-guide.md.txt2
1 files changed, 1 insertions, 1 deletions
diff --git a/pages/contrib/docs/eo-guide.md.txt b/pages/contrib/docs/eo-guide.md.txt
index e033e0cf3..3cfe049fc 100644
--- a/pages/contrib/docs/eo-guide.md.txt
+++ b/pages/contrib/docs/eo-guide.md.txt
@@ -64,7 +64,7 @@ Bear in mind that documentation tags placed elsewhere will be ignored and may ev
64 64
65 * Start all your sentences with Upper Case. 65 * Start all your sentences with Upper Case.
66 * End all your sentences with periods. 66 * End all your sentences with periods.
67 * Keep your lines under 80 characters. 67 * Keep your lines under 120 characters.
68 * Document properties at the ``@property ... {`` level. In other words, do not document the property's ``get`` and ``set`` methods (accessors) independently. If the methods really do something other than setting and getting a property, then put as much common text at the ``@property`` level and only put whatever's different in the accessors. 68 * Document properties at the ``@property ... {`` level. In other words, do not document the property's ``get`` and ``set`` methods (accessors) independently. If the methods really do something other than setting and getting a property, then put as much common text at the ``@property`` level and only put whatever's different in the accessors.
69 * Start the description of methods with a verb in singular form, that is, ``Destroys the object`` and not *Destroy the object*. 69 * Start the description of methods with a verb in singular form, that is, ``Destroys the object`` and not *Destroy the object*.
70 * Methods returning a Boolean (like ``is_object_a_box``) should start with the phrase ``Returns $true if`` (or ``$false``). For example: ``Returns $true if the $object parameter is of the box type.``. 70 * Methods returning a Boolean (like ``is_object_a_box``) should start with the phrase ``Returns $true if`` (or ``$false``). For example: ``Returns $true if the $object parameter is of the box type.``.