Developer guide

Jump to bottom

nepJIywa edited this page Oct 23, 2018 · 6 revisions

Function naming

Standart name type - words are separated by underscores
function_name
When naming subfuction, mark it with underscore and parent function name in camelcase
_functionName___subfunction_name
Quantity of undersores determines nesting level of subfunction. Ex: 2 for sub-subfunction
__subfunctionName___subsubfunction_name

Comments example

STP interface options check
Input:
- interface dictionary
- config result dictionary
Output:
- updated result dictionary
  - {'STP': {'portfast': [severity(int), 'message', 'best practice']}