Added usage docstring to test scripts

Foggalong · Aug 7, 2024 · dfb2986 · dfb2986
1 parent 2431410
commit dfb2986
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 0 deletions.
diff --git a/examples/04/test.py b/examples/04/test.py
@@ -1,5 +1,11 @@
 #!/usr/bin/env python3
 
+"""
+While this script may be used as an example of using RobustOCS, it's primarily
+intended for use as a test as part of the 'Check Build' GitHub action.
+https://github.com/Foggalong/RobustOCS/actions/workflows/check-build.yml
+"""
+
 import numpy as np
 import robustocs as rocs
 

diff --git a/examples/1000/test.py b/examples/1000/test.py
@@ -3,6 +3,12 @@
 import numpy as np
 import robustocs as rocs
 
+"""
+While this script may be used as an example of using RobustOCS, it's primarily
+intended for use as a test as part of the 'Check Build' GitHub action.
+https://github.com/Foggalong/RobustOCS/actions/workflows/check-build.yml
+"""
+
 # SETUP
 # -----
 

diff --git a/examples/50/test.py b/examples/50/test.py
@@ -3,6 +3,12 @@
 import numpy as np
 import robustocs as rocs
 
+"""
+While this script may be used as an example of using RobustOCS, it's primarily
+intended for use as a test as part of the 'Check Build' GitHub action.
+https://github.com/Foggalong/RobustOCS/actions/workflows/check-build.yml
+"""
+
 # SETUP
 # -----
 

diff --git a/examples/ped/test.py b/examples/ped/test.py
@@ -1,7 +1,15 @@
+#!/usr/bin/env python3
+
 import numpy as np
 import robustocs as rocs
 from time import time
 
+"""
+While this script may be used as an example of using RobustOCS, it's primarily
+intended for use as a test as part of the 'Test Pedigree' GitHub action.
+https://github.com/Foggalong/RobustOCS/actions/workflows/check-pedigree.yml
+"""
+
 
 ped = rocs.load_ped("example.ped")