From c3c903d008559ee9bf3f73eadc0cdc6bd07bb08b Mon Sep 17 00:00:00 2001 From: Hugo Oliveira Date: Mon, 26 Oct 2020 16:02:38 +1100 Subject: [PATCH] feat(docstrings): fix docstrings test evaluations --- Util/Path/FilesInFolder.m | 15 +++++++-------- Util/Path/files2namestruct.m | 10 +++++----- Util/Path/rdir.m | 25 ++++++++++--------------- Util/Path/toolboxRootPath.m | 7 ++++--- Util/Time/nextLowerTimePrecision.m | 4 ++-- Util/Units/toCelsius.m | 6 +++--- Util/getIMOSType.m | 2 +- 7 files changed, 32 insertions(+), 37 deletions(-) diff --git a/Util/Path/FilesInFolder.m b/Util/Path/FilesInFolder.m index e5d71f73f..dde2ebbb7 100644 --- a/Util/Path/FilesInFolder.m +++ b/Util/Path/FilesInFolder.m @@ -15,14 +15,13 @@ % folders - a cell with fullpath strings of the subfolders. % % Example: -% % assumes /dev/shm got 4 files, "_a","1b","1_ab","abc.m". -% path = '/dev/shm'; -% [files] = FilesInFolder(path); -% assert(any(contains(files,'1_ab'))); -% assert(any(contains(files,'1b'))); -% assert(any(contains(files,'_a'))); -% assert(any(contains(files,'abc.m'))); - +% +% [files] = FilesInFolder(toolboxRootPath); +% assert(any(contains(files,'imosToolbox.m'))); +% assert(any(contains(files,'license.txt'))); +% assert(any(contains(files,'toolboxProperties.txt'))); +% +% % author: hugo.oliveira@utas.edu.au % diff --git a/Util/Path/files2namestruct.m b/Util/Path/files2namestruct.m index ab75df118..2bea347b3 100644 --- a/Util/Path/files2namestruct.m +++ b/Util/Path/files2namestruct.m @@ -14,11 +14,11 @@ % % Example: % carg = {'/dev/shm/_a','/dev/shm/1b','/dev/shm/1_ab','/dev/shm/abc.m'}; -% [named_struct] = cell2namestruct(carg); -% assert(strcmpi(cargs.x_a,'/dev/shm/_a')); -% assert(strcmpi(cargs.x1b,'/dev/shm/1b')); -% assert(strcmpi(cargs.x1abc,'/dev/shm/1abc')); -% assert(strcmpi(cargs.abc_m,'/dev/shm/abc.m')); +% [named_struct] = files2namestruct(carg); +% assert(strcmpi(named_struct.x_a,'/dev/shm/_a')); +% assert(strcmpi(named_struct.x1b,'/dev/shm/1b')); +% assert(strcmpi(named_struct.x1_ab,'/dev/shm/1_ab')); +% assert(strcmpi(named_struct.abc_m,'/dev/shm/abc.m')); % % author: hugo.oliveira@utas.edu.au % diff --git a/Util/Path/rdir.m b/Util/Path/rdir.m index 22280354f..f43604aa6 100644 --- a/Util/Path/rdir.m +++ b/Util/Path/rdir.m @@ -1,29 +1,24 @@ function [files, folders] = rdir(path) % function files,folders = rdir(path) % -% recursive dir - List all children given a path (files/folders) +% Recursively list all files/folders in +% a given a path. % % Inputs: % -% path - a path string +% path [str] - a folder path % % Outputs: % -% `files` - a cell with fullpath string of all files at all levels. -% `folders` - a cell with fullpath strings of all subfolders at all levels. +% files [cell] - file path strings at all root/sub folder levels. +% folders [cell] - folder path strings at all sub-folder levels. % % Example: -% % assumes /dev/shm/a,/dev/shm/b are files -% % assumes /dev/shm/c/d/e/f/g/h/i is a file -% % assumes /dev/shm/c/d/e/f/g/h/j is a empty folder -% path = '/dev/shm' -% [allfiles,allfolders] = rdir(path); -% assert(strcmp(allfiles{1}, '/dev/shm/a')); -% assert(strcmp(allfiles{2}, '/dev/shm/b')); -% assert(strcmp(allfiles{3}, '/dev/shm/c/d/e/f/g/h/i')); -% assert(strcmp(allfolders{1},'/dev/shm/c')); -% assert(strcmp(allfolders{2},'/dev/shm/c/d')); -% assert(strcmp(allfolders{end},'/dev/shm/c/d/e/f/g/h/j')); +% +% %simple test with nest folders +% [allfiles,allfolders] = rdir([toolboxRootPath 'Java']); +% assert(sum(contains(allfolders,'Java/bin'))==4) +% assert(sum(contains(allfiles,'ddb.jar'))==1) % % author: hugo.oliveira@utas.edu.au % diff --git a/Util/Path/toolboxRootPath.m b/Util/Path/toolboxRootPath.m index 70a83a41a..3257977ec 100644 --- a/Util/Path/toolboxRootPath.m +++ b/Util/Path/toolboxRootPath.m @@ -8,9 +8,10 @@ % root_path - a string path of the toolbox root % % Example: -% % assumes toolbox is at /home/user/imos-toolbox -% [root_path] = toolboxRootPath() -% assert(strcmp('/home/user/imos-toolbox/',root_path) +% +% [root_path] = toolboxRootPath(); +% assert(~isempty(root_path)) +% assert(any(contains(FilesInFolder(root_path),'imosToolbox.m'))) % % author: hugo.oliveira@utas.edu.au % diff --git a/Util/Time/nextLowerTimePrecision.m b/Util/Time/nextLowerTimePrecision.m index fa4830af0..7650bd735 100644 --- a/Util/Time/nextLowerTimePrecision.m +++ b/Util/Time/nextLowerTimePrecision.m @@ -13,8 +13,8 @@ % % Example: % -% prec = 'microsecond' -% [lower_prec] = nextLowerTimePrecision(prec) +% prec = 'microsecond'; +% [lower_prec] = nextLowerTimePrecision(prec); % assert(strcmp(lower_prec,'milisecond')) % % author: hugo.oliveira@utas.edu.au diff --git a/Util/Units/toCelsius.m b/Util/Units/toCelsius.m index 69b30be4e..6adeba9db 100644 --- a/Util/Units/toCelsius.m +++ b/Util/Units/toCelsius.m @@ -15,11 +15,11 @@ % Example: % % degC = toCelsius([300.15],'kelvin'); -% assert(degC==27); +% assert(round(degC)==27); % degC = toCelsius([27],'celsius'); -% assert(degC==27); +% assert(round(degC)==27); % degC = toCelsius([80.6],'fahr'); -% assert(DegC==27); +% assert(round(degC)==27); % % % author: hugo.oliveira@utas.edu.au diff --git a/Util/getIMOSType.m b/Util/getIMOSType.m index c8b9e17ec..cf1bf8a73 100644 --- a/Util/getIMOSType.m +++ b/Util/getIMOSType.m @@ -13,7 +13,7 @@ % type % % Example: -% [mtype] = getIMOSType('TEMP') +% [mtype] = getIMOSType('TEMP'); % assert(isequal(mtype,@single)) % % author: hugo.oliveira@utas.edu.au