Skip to content

Commit 062be13

Browse files
neuronflowCopilot
andauthored
Update brainles_preprocessing/utils/citation_reminder.py
why not Co-authored-by: Copilot <[email protected]>
1 parent ea83647 commit 062be13

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

brainles_preprocessing/utils/citation_reminder.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,16 @@
77

88

99
def citation_reminder(func):
10-
"""Decorator to remind users to cite brainles-preprocessing."""
11-
10+
"""
11+
Decorator to remind users to cite brainles-preprocessing.
12+
13+
The reminder is shown when the environment variable
14+
`BRAINLES_PREPROCESSING_CITATION_REMINDER` is set to "true" (default).
15+
To disable the reminder, set the environment variable to "false".
16+
17+
Environment variable used:
18+
- BRAINLES_PREPROCESSING_CITATION_REMINDER: Controls whether the reminder is shown.
19+
"""
1220
@functools.wraps(func)
1321
def wrapper(*args, **kwargs):
1422
if (

0 commit comments

Comments
 (0)