BICAS: rdtp: Rename top-level functions

renamed: src/+bicas/+tools/+rtdp/main.m -> src/+bicas/+tools/+rtdp/create_RCS_test_data_package.m modified: src/+bicas/+tools/+rtdp/misc.m modified: src/+bicas/+tools/+rtdp/misc___UTEST.m
irfu · Sep 13, 2024 · ec52715 · ec52715
1 parent 4af16ba
commit ec52715
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 10 deletions.
diff --git a/...iter/bicas/src/+bicas/+tools/+rtdp/main.m → ...ools/+rtdp/create_RCS_test_data_package.m b/...iter/bicas/src/+bicas/+tools/+rtdp/main.m → ...ools/+rtdp/create_RCS_test_data_package.m
@@ -31,8 +31,8 @@
 %
 %
 % Author: Erik P G Johansson, IRF, Uppsala, Sweden
-function main(outputParentDir, letterVersion, configFile)
-% bicas.tools.rtdp.main('/nonhome_data/SOLAR_ORBITER/bicas_test_packages/temp', 'A', '/nonhome_data/work_files/SOLAR_ORBITER/rtdp_config.json')
+function create_RCS_test_data_package(outputParentDir, letterVersion, configFile)
+% bicas.tools.rtdp.create_RCS_test_data_package('/nonhome_data/SOLAR_ORBITER/bicas_test_packages/temp', 'A', '/nonhome_data/work_files/SOLAR_ORBITER/rtdp_config.json')
 %
 % PROPOSAL: Better name for function.
 %     create
@@ -51,6 +51,6 @@ function main(outputParentDir, letterVersion, configFile)
 %     rcstdpkg  (TD = Test Data)
 %     rtdp      (= RCS Test Data Package)
 
-bicas.tools.rtdp.misc.create_RCS_test_pkg(...
+bicas.tools.rtdp.misc.create_RCS_test_data_package(...
   outputParentDir, letterVersion, configFile, false)
 end
diff --git a/mission/solar_orbiter/bicas/src/+bicas/+tools/+rtdp/misc.m b/mission/solar_orbiter/bicas/src/+bicas/+tools/+rtdp/misc.m
@@ -30,22 +30,22 @@
 
 
 
-    % De facto top-level function for the bicas.tools.rtdp package, with
-    % the added argument automatedTestRun for tests. The nominal user is
-    % supposed to call bicas.tools.rtdp.main() (a trivial wrapper) but
-    % tests should call this function.
+    % De facto top-level function for the bicas.tools.rtdp package, with the
+    % added argument automatedTestRun for tests. The nominal user is supposed
+    % to call bicas.tools.rtdp.create_RCS_test_data_package() (a trivial
+    % wrapper) but tests should call this function.
     %
     %
     % ARGUMENTS
     % =========
-    % See bicas.tools.rtdp.main().
+    % See bicas.tools.rtdp.create_RCS_test_data_package().
     % automatedTestRun
     %       Whether the function is called by an automated test or not.
     %       NOTE: This is substitute for submitting a class for calling BICAS
     %       (or a function handle), which would then be mocked for tests, which
     %       would be overkill for this application.
     %
-    function create_RCS_test_pkg( ...
+    function create_RCS_test_data_package( ...
         outputParentDir, letterVersion, configFile, automatedTestRun)
       %
       % PROPOSAL: Separate function file.

diff --git a/mission/solar_orbiter/bicas/src/+bicas/+tools/+rtdp/misc___UTEST.m b/mission/solar_orbiter/bicas/src/+bicas/+tools/+rtdp/misc___UTEST.m
@@ -62,7 +62,7 @@ function test0(testCase)
       % TEMP_CONFIG_FILE = '/home/erjo/temp/temp/roctestpkg.json';
       TEMP_CONFIG_FILE = testCase.configFile;
 
-      bicas.tools.rtdp.misc.create_RCS_test_pkg(...
+      bicas.tools.rtdp.misc.create_RCS_test_data_package(...
         testCase.dir, 'A', TEMP_CONFIG_FILE, true)
     end