-
Notifications
You must be signed in to change notification settings - Fork 91
Entwicklungs Richtlinien
msinn edited this page Aug 5, 2017
·
5 revisions
- Die Entwicklung sollte sich an PEP 8 -- Style Guide for Python Code anlehnen.
- Funktions-, Attributs- / Klassenbezeichnungen (etc.) und Kommentare bitte in Englisch
- Codekommentare so, dass sie mit Sphinx generiert werden können (http://thomas-cokelaer.info/tutorials/sphinx/docstring_python.html).
Beispiel (Methodenkommentar):
"""
Builds the soap data set (from body and envelope templates) for a given request.
:param action: string of the action
:param service: string of the service
:param argument: dictionary (name : value) of arguments
:type action: str
:type service: str
:type argument: dict
:return: string of the soap data
:rtype: str
"""
Für die Plugin-Entwicklung werden die o.g. Guidelines empfohlen.
Die aktuellen Release Notes und die Release Notes der zurückliegenden Versionen sind in der Dokumentation im Abschnitt Release Notes zu finden.