note about renaming/symlinking

SyneRBI · Jul 5, 2024 · 46ec6b6 · 46ec6b6
1 parent 4301b7c
commit 46ec6b6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/main_BSREM.py b/main_BSREM.py
@@ -1,4 +1,6 @@
-"""Main file to modify for submissions. It is used by e.g. example.ipynb and petric.py as follows:
+"""Main file to modify for submissions.
+
+Once renamed or symlinked as `main.py`, it will be used by `petric.py` as follows:
 
 >>> from main import Submission, submission_callbacks
 >>> from petric import data, metrics

diff --git a/main_ISTA.py b/main_ISTA.py
@@ -1,4 +1,6 @@
-"""Main file to modify for submissions. It is used by e.g. example.ipynb and petric.py as follows:
+"""Main file to modify for submissions.
+
+Once renamed or symlinked as `main.py`, it will be used by `petric.py` as follows:
 
 >>> from main import Submission, submission_callbacks
 >>> from petric import data, metrics