Merge branch '138-feature-citation-reminder' of github.com:BrainLesion/preprocessing into 138-feature-citation-reminder

Author: MarcelRosier

brainles_preprocessing/utils/citation_reminder.py

@@ -7,7 +7,16 @@
 
 
 def citation_reminder(func):
-    """Decorator to remind users to cite brainles-preprocessing."""
+    """
+    Decorator to remind users to cite brainles-preprocessing.
+
+    The reminder is shown when the environment variable
+    `BRAINLES_PREPROCESSING_CITATION_REMINDER` is set to "true" (default).
+    To disable the reminder, set the environment variable to "false".
+
+    Environment variable used:
+    - BRAINLES_PREPROCESSING_CITATION_REMINDER: Controls whether the reminder is shown.
+    """
 
     @functools.wraps(func)
     def wrapper(*args, **kwargs):