src/hdalab/services.py
branchdocumentation
changeset 693 09e00f38d177
parent 686 385e3a12ee27
--- a/src/hdalab/services.py	Thu Apr 12 01:27:16 2018 +0200
+++ b/src/hdalab/services.py	Wed Apr 11 12:19:47 2018 +0200
@@ -23,6 +23,14 @@
 
 @transaction.atomic
 def change_renkan_state(hda_renkan, state, message=None, author=None):
+    """
+    Change l'état d'un renkan et crée un objet :class:`hdalab.models.HdalabRenkanStateTransition` dans une transaction unique.
+
+    :param:hda_renkan: L'objet :class:`hdalab.models.HdaRenkan`.
+    :param:state: L'état cible.
+    :param:message: Le message de changement d'état.
+    :param:author: L'utilisateur (:class:`hdabo.models.User`).
+    """
 
     if state != hda_renkan.state:
 
@@ -32,6 +40,13 @@
 
 
 def renkan_capture_preview(hdalab_renkan):
+    """
+    Lance la création d'une miniature pour un renkan.
+    Ceci est fait en ouvrant l'url `renkan_full` (:ref:`affichage-d-un-renkan-en-plein-ecran`) avec PhantomJS, et en déclenchant une capture "d'écran".
+
+    :param:hdalab_renkan: Une instance de :class:`hdalab.models.renkan.HdalabRenkan`.
+
+    """
     #get last state date or last modification date
     #states are ordered by ts
     folder_date = hdalab_renkan.renkan.modification_date