diff --git a/examples/1-basic-concepts/understanding-data-part-1/python.bpmn b/examples/1-basic-concepts/understanding-data-part-1/python.bpmn index d7271bf7..14e1f53f 100644 --- a/examples/1-basic-concepts/understanding-data-part-1/python.bpmn +++ b/examples/1-basic-concepts/understanding-data-part-1/python.bpmn @@ -1,5 +1,5 @@ - + Flow_0bngcu2 @@ -7,6 +7,7 @@ Flow_0bngcu2 + Flow_0ggy7w4 # Creating Variables age = 51 # This is an integer @@ -44,6 +45,32 @@ cabinet = { + + + + # Readability +The creator of Python Guido van Rossum, said + “Code is read much more often than it’s written.” IT's important to create code that is easy to understand later on. + +For this reason we recommend following a popular standard called [PEP8](https://realpython.com/python-pep8/) + +Here are some highlights from the standard, along with a few additions specific to working with SpiffWorkflow: + +## Variables + +### Formatting: +being consistent in the naming of your variables makes them far easier to remember. If you always use lower case and separate words with underscores, you don't have to try and remember the formatting, you just have to remember what it is called. If everyone follows this standard, then you can remember their variables easier as well ... + + * my_name (GOOD) + * MyName (NO) + * myname (NO) + +### Use Thoughtful names. +* + + + Flow_0ggy7w4 + @@ -53,10 +80,18 @@ cabinet = { + + + + + + + +