|
@@ -71,7 +71,18 @@ the message variable must be a Dict of variable:values where variables can be de
|
|
|
1. The Neuron must (as much as possible) ensure the i18n. This means that they should __not manage a specific languages__ inside its own logic.
|
|
|
Only [Synapse](brain.md) by the use of [Order](signals.md) must interact with the languages. This allow a Neuron to by reused by anyone, speaking any language.
|
|
|
|
|
|
-1. The Neuron must follow the [PEP8](https://www.python.org/dev/peps/pep-0008/) and the docstring [PEP257](https://www.python.org/dev/peps/pep-0257/).
|
|
|
+1. Respect [PEP 257](https://www.python.org/dev/peps/pep-0257/) -- Docstring conventions. For each class or method add a description with summary, input parameter, returned parameter, type of parameter
|
|
|
+ ```
|
|
|
+ def my_method(my_parameter):
|
|
|
+ """
|
|
|
+ Description of he method
|
|
|
+ :param my_parameter: description of he parameter
|
|
|
+ :type my_parameter: str
|
|
|
+ """
|
|
|
+ ```
|
|
|
+
|
|
|
+1. Respect [PEP 8](https://www.python.org/dev/peps/pep-0008/) -- Style Guide for Python Code
|
|
|
+We recommend the usage of an IDE like [Pycharm](https://www.jetbrains.com/pycharm/)
|
|
|
|
|
|
##### Limitations
|
|
|
|