Merge pull request #1375 from pace-neutrons/1303c-typo-cleanup

1303c Cleanup typos in various files

_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();

_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();

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

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{:});

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;

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

herbert_core/utilities/classes/@IX_data_3d/IX_data_3d.m

@@ -33,23 +33,23 @@
     %   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
         x_axis;
         % 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
         y_axis;
         % 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)

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:> <doc_file_header>
-%
-%   <#file:> <doc_file_IO> <list_operator_arg>
 % <#doc_end:>
 % -----------------------------------------------------------------------------
 
-% Simply returns without change:
 w = w1;

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
 

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

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