From 50ae8ce59fd2b872450a217caff1a2476fc57743 Mon Sep 17 00:00:00 2001 From: Jacob Wilkins Date: Thu, 9 Nov 2023 11:58:07 +0000 Subject: [PATCH] Cleanup typos in various files --- _test/test_sqw/test_sqw_save_xye.m | 2 +- .../test_sqw_activate_deactivate.m | 2 +- _test/test_sqw_pixels/test_mask.m | 2 +- .../private/load_configuration_.m | 3 ++- .../utilities/classes/@IX_axis/IX_axis.m | 2 +- .../utilities/classes/@IX_data_1d/IX_data_1d.m | 6 +++--- .../utilities/classes/@IX_data_2d/point2hist.m | 2 +- .../utilities/classes/@IX_data_3d/IX_data_3d.m | 18 +++++++++--------- herbert_core/utilities/classes/@sigvar/uplus.m | 10 ++-------- .../configuration/@hpc_config/hpc_config.m | 2 +- horace_core/sqw/@sqw/get_nearest_pixels.m | 2 +- .../sqw/page_operations/PageOp_unary_op.m | 2 +- 12 files changed, 24 insertions(+), 29 deletions(-) diff --git a/_test/test_sqw/test_sqw_save_xye.m b/_test/test_sqw/test_sqw_save_xye.m index 79a2239ad8..787e059692 100644 --- a/_test/test_sqw/test_sqw_save_xye.m +++ b/_test/test_sqw/test_sqw_save_xye.m @@ -1,5 +1,5 @@ classdef test_sqw_save_xye < TestCase - % Series of tests to check work of mex files against Matlab files + % Series of tests to check work of xye operations properties out_dir = tmp_dir(); diff --git a/_test/test_sqw_pageOpMethods/test_sqw_activate_deactivate.m b/_test/test_sqw_pageOpMethods/test_sqw_activate_deactivate.m index 99a46b3f85..3da305e23f 100644 --- a/_test/test_sqw_pageOpMethods/test_sqw_activate_deactivate.m +++ b/_test/test_sqw_pageOpMethods/test_sqw_activate_deactivate.m @@ -1,5 +1,5 @@ classdef test_sqw_activate_deactivate< TestCase - % Series of tests to check work of mex files against Matlab files + % Series of tests to check work of mex files against MATLAB files properties out_dir = tmp_dir(); diff --git a/_test/test_sqw_pixels/test_mask.m b/_test/test_sqw_pixels/test_mask.m index 8d92bb61bb..a3ae716c42 100644 --- a/_test/test_sqw_pixels/test_mask.m +++ b/_test/test_sqw_pixels/test_mask.m @@ -1,4 +1,4 @@ -classdef test_mask < TestCase & common_pix_class_state_holder +classdef test_mask < TestCase properties diff --git a/herbert_core/admin/@opt_config_manager/private/load_configuration_.m b/herbert_core/admin/@opt_config_manager/private/load_configuration_.m index 2992472883..7e11b9a3cf 100644 --- a/herbert_core/admin/@opt_config_manager/private/load_configuration_.m +++ b/herbert_core/admin/@opt_config_manager/private/load_configuration_.m @@ -9,7 +9,8 @@ % config_file = fullfile(obj.config_info_folder,obj.config_filename); if ~(is_file(config_file)) - warning('No existing configuration file %s found. Current configuration left unchanged',... + warning('HORACE:no_default_configuration', ... + 'No pre-defined optimal configuration file: %s have been found. Class-default configuration left unchanged',... config_file) return; end diff --git a/herbert_core/utilities/classes/@IX_axis/IX_axis.m b/herbert_core/utilities/classes/@IX_axis/IX_axis.m index 4fd121939e..e21ea367f6 100644 --- a/herbert_core/utilities/classes/@IX_axis/IX_axis.m +++ b/herbert_core/utilities/classes/@IX_axis/IX_axis.m @@ -40,7 +40,7 @@ % Setting custom tick positions and labels % >> w = IX_axis (...,vals) % positions % >> w = IX_axis (...,vals,labels) % positions and labels - % >> w = IX_axis (...,ticks) % strucutre with position and tick labels + % >> w = IX_axis (...,ticks) % structure with position and tick labels % if nargin > 0 axis = buildIX_axis_(axis,varargin{:}); diff --git a/herbert_core/utilities/classes/@IX_data_1d/IX_data_1d.m b/herbert_core/utilities/classes/@IX_data_1d/IX_data_1d.m index 576244ed17..21447c9d14 100644 --- a/herbert_core/utilities/classes/@IX_data_1d/IX_data_1d.m +++ b/herbert_core/utilities/classes/@IX_data_1d/IX_data_1d.m @@ -87,15 +87,15 @@ obj.xyz_axis_(1) = obj.check_and_build_axis(val); end function obj = set.x_distribution(obj,val) - % TODO: should setting it to true/false involve chaning x from - % disrtibution to bin centers and v.v.? + % TODO: should setting it to true/false involve changing x from + % distribution to bin centres and v.v.? obj.xyz_distribution_(1) = logical(val); end function [frac,n_points] = calc_continuous_fraction(obj) % Calculate the fraction of continuous areas of plot % not containing NaNs, so to be displayed on a plot. % e.g: - % if signal = [1,NaN,2,3,NaN,4] the continuious plot area would + % if signal = [1,NaN,2,3,NaN,4] the continuous plot area would % be 2,3, and points 1 and 4 are not displaying if you are % plotting a line. Such dataset contains 4 points, only two % would be plotted by pl, so the function returns frac = 2/4 = 0.5; diff --git a/herbert_core/utilities/classes/@IX_data_2d/point2hist.m b/herbert_core/utilities/classes/@IX_data_2d/point2hist.m index 61f14d4fa2..4293e73a5e 100644 --- a/herbert_core/utilities/classes/@IX_data_2d/point2hist.m +++ b/herbert_core/utilities/classes/@IX_data_2d/point2hist.m @@ -28,7 +28,7 @@ if isnumeric(iax) && isvector(iax) % is non-empty vector (including non-empty scalar) if any(mod(iax,1)~=0)||numel(iax)>nd||numel(unique(iax))~=numel(iax)||... any(iax<1)||any(iax>nd) - error('Check indicies of axes to be converted') + error('Check indices of axes to be converted') end if any(iax==1), convert_x=true; else convert_x=false; end if any(iax==2), convert_y=true; else convert_y=false; end diff --git a/herbert_core/utilities/classes/@IX_data_3d/IX_data_3d.m b/herbert_core/utilities/classes/@IX_data_3d/IX_data_3d.m index 75821b8b6b..155ed68ce9 100644 --- a/herbert_core/utilities/classes/@IX_data_3d/IX_data_3d.m +++ b/herbert_core/utilities/classes/@IX_data_3d/IX_data_3d.m @@ -33,7 +33,7 @@ % z_axis IX_axis |- same as above but for z-axis % z_distribution logical -| properties(Dependent) - % x - vector of bin boundaries for histogram data or bin centers + % x - vector of bin boundaries for histogram data or bin centres % for distribution x % x_axis -- IX_axis class containing x-axis caption @@ -41,7 +41,7 @@ % x_distribution -- an identifier, stating if the x-data contain % points or distribution in x-direction x_distribution; - % y - vector of bin boundaries for histogram data or bin centers + % y - vector of bin boundaries for histogram data or bin centres % for distribution in y-direction y % y_axis -- IX_axis class containing y-axis caption @@ -49,7 +49,7 @@ % y_distribution -- an identifier, stating if the y-data contain % points or distribution in y-direction y_distribution; - % z - vector of bin boundaries for histogram data or bin centers + % z - vector of bin boundaries for histogram data or bin centres % for distribution in z-direction z % z_axis -- IX_axis class containing z-axis caption @@ -118,8 +118,8 @@ obj.xyz_axis_(1) = obj.check_and_build_axis(val); end function obj = set.x_distribution(obj,val) - % TODO: should setting it to true/false involve chaning x from - % disrtibution to bin centers and v.v.? + % TODO: should setting it to true/false involve changing x from + % distribution to bin centres and v.v.? obj.xyz_distribution_(1) = logical(val); end %----------------------------------------------------------------- @@ -142,8 +142,8 @@ end end function obj = set.y_distribution(obj,val) - % TODO: should setting it to true/false involve chaning y from - % disrtibution to bin centers and v.v.? + signal changes + % TODO: should setting it to true/false involve changing y from + % distribution to bin centres and v.v.? + signal changes obj.xyz_distribution_(2) = logical(val); end function obj = set.y_axis(obj,val) @@ -169,8 +169,8 @@ end end function obj = set.z_distribution(obj,val) - % TODO: should setting it to true/false involve chaning y from - % disrtibution to bin centers and v.v.? + signal changes + % TODO: should setting it to true/false involve changing y from + % distribution to bin centres and v.v.? + signal changes obj.xyz_distribution_(3) = logical(val); end function obj = set.z_axis(obj,val) diff --git a/herbert_core/utilities/classes/@sigvar/uplus.m b/herbert_core/utilities/classes/@sigvar/uplus.m index 4b17104769..6293e3e6e5 100644 --- a/herbert_core/utilities/classes/@sigvar/uplus.m +++ b/herbert_core/utilities/classes/@sigvar/uplus.m @@ -1,20 +1,14 @@ -function w = uplus (w1) +function w = uplus(w1) % ----------------------------------------------------------------------------- % <#doc_def:> % doc_dir = fullfile(fileparts(which('sigvar')),'_docify') +% doc_file_header = fullfile(doc_dir,'doc_sigvar_unary_single.m') % -% doc_file_header = fullfile(doc_dir,'doc_unary_header.m') -% doc_file_IO = fullfile(doc_dir,'doc_unary_general_args_IO_description.m') -% -% list_operator_arg = 0 % func_name = 'uplus' % ----------------------------------------------------------------------------- % <#doc_beg:> binary_and_unary_ops % <#file:> -% -% <#file:> % <#doc_end:> % ----------------------------------------------------------------------------- -% Simply returns without change: w = w1; diff --git a/horace_core/configuration/@hpc_config/hpc_config.m b/horace_core/configuration/@hpc_config/hpc_config.m index f65a85b1f9..657f515ee4 100644 --- a/horace_core/configuration/@hpc_config/hpc_config.m +++ b/horace_core/configuration/@hpc_config/hpc_config.m @@ -202,7 +202,7 @@ p_mf = get_or_restore_field(obj,'parallel_multifit'); end - function accum = get.parallel_workers_number(obj) + function accum = get.parallel_workers_number(~) accum = config_store.instance.get_value('parallel_config','parallel_workers_number'); end diff --git a/horace_core/sqw/@sqw/get_nearest_pixels.m b/horace_core/sqw/@sqw/get_nearest_pixels.m index 3fc3bde68b..5851a2b9c4 100644 --- a/horace_core/sqw/@sqw/get_nearest_pixels.m +++ b/horace_core/sqw/@sqw/get_nearest_pixels.m @@ -24,7 +24,7 @@ % - 0 indicates the point lies in a bin without any contributing % pixels, or the point lies outside the range of the sqw dataset % -% ipix Column vector with the indicies of the nearest pixel to each +% ipix Column vector with the indices of the nearest pixel to each % for which ok is true; that is for those points given by xp(ok,:) % % The nearest pixel is defined as that which has minimum distance diff --git a/horace_core/sqw/page_operations/PageOp_unary_op.m b/horace_core/sqw/page_operations/PageOp_unary_op.m index fac63269ea..43bfd791ad 100644 --- a/horace_core/sqw/page_operations/PageOp_unary_op.m +++ b/horace_core/sqw/page_operations/PageOp_unary_op.m @@ -4,7 +4,7 @@ % % properties - % property contains + % property contains handle to function, which performs operation op_handle; end