From dfb2986317a8ffc1ba420f65e4f9b0af1f16bfac Mon Sep 17 00:00:00 2001 From: Joshua Fogg Date: Wed, 7 Aug 2024 12:06:44 +0100 Subject: [PATCH] Added usage docstring to test scripts --- examples/04/test.py | 6 ++++++ examples/1000/test.py | 6 ++++++ examples/50/test.py | 6 ++++++ examples/ped/test.py | 8 ++++++++ 4 files changed, 26 insertions(+) diff --git a/examples/04/test.py b/examples/04/test.py index 072b9e5..27b1a6e 100644 --- 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 index 99561a3..f597623 100644 --- 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 index d166706..9ead238 100644 --- 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 index 3fcb937..715cbd9 100644 --- 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")