doc formatting

Author: scivision

+stdlib/+fileio/absolute_path.m

@@ -6,9 +6,9 @@
 % subsystem, but are sometimes still valid--so return
 % unmodified path if this occurs.
 %
-%% Inputs
+%%% Inputs
 % * p: path to make absolute
-%% Outputs
+%%% Outputs
 % * abspath: absolute path, if determined
 
 arguments

+stdlib/+fileio/expanduser.m

@@ -4,9 +4,10 @@
 %
 % Useful for Matlab functions like h5read() and some Computer Vision toolbox functions
 % that can't handle ~
-%% Inputs
+%
+%%% Inputs
 % * p: path to expand, if tilde present
-%% Outputs
+%%% Outputs
 % * expanded: expanded path
 %
 % See also ABSOLUTE_PATH

+stdlib/+fileio/is_exe.m

@@ -2,9 +2,9 @@
 %% is_exe(file)
 % is a file executable, as per its filesystem attributes
 % does not actually try to run the file.
-%% Inputs
+%%% Inputs
 % * file: filename
-%% Outputs
+%%% Outputs
 % * ok: boolean logical
 
 arguments

+stdlib/+fileio/is_wsl_path.m

@@ -1,6 +1,6 @@
 function iswsl = is_wsl_path(path)
 arguments
-  path (1,1) string
+  path (1,1) string {mustBeNonzeroLengthText}
 end
 
 if ispc

+stdlib/+fileio/with_suffix.m

@@ -1,10 +1,10 @@
 function filename = with_suffix(filename, suffix)
 %% with_suffix(filename, suffix)
 % switch file extension
-%% Inputs
+%%% Inputs
 % * filename: original filename
 % * suffix: file extension with "." e.g. ".dat"
-%% Outputs
+%%% Outputs
 % * filename: modified filename
 arguments
   filename string

+stdlib/+hdf5nc/auto_chunk_size.m

@@ -4,7 +4,7 @@
 % based on https://github.com/h5py/h5py/blob/master/h5py/_hl/filters.py
 % refer to https://support.hdfgroup.org/HDF5/Tutor/layout.html
 %
-%% Inputs
+%%% Inputs
 % * dims: proposed dataset dimensions (like size())
 
 arguments

+stdlib/+hdf5nc/h5create_group.m

@@ -2,11 +2,11 @@
 %% h5create_group(file, hpath)
 % create HDF5 group
 %
-%% Inputs
+%%% Inputs
 % * file: HDF5 file name or handle
 % * hpath: HDF5 group/dataset -- ensure final character is "/" if hpath is only a group
 %
-%% Outputs
+%%% Outputs
 % * HDF5 file handle
 
 arguments
@@ -16,7 +16,7 @@
 
 import stdlib.fileio.expanduser
 
-%% polymorphic fid/filename
+% polymorphic fid/filename
 if isa(file, 'H5ML.id')
   fid = file;
 else
@@ -29,13 +29,13 @@
   end
 end
 
-%% are there any groups
+% are there any groups
 grps = split(hpath, "/");
 if length(grps) < 3
   return
 end
 
-%% recursively create groups as needed
+% recursively create groups as needed
 plist = 'H5P_DEFAULT';
 groot = H5G.open(fid, "/");
 

+stdlib/+hdf5nc/h5exists.m

@@ -2,11 +2,11 @@
 %% H5EXISTS(file, vars)
 % check if object(s) exists in HDF5 file
 %
-%% Inputs
+%%% Inputs
 % * file: data filename
 % * varname: path(s) of variable in file
 %
-%% Outputs
+%%% Outputs
 % * exists: boolean (scalar or vector)
 
 arguments

+stdlib/+hdf5nc/h5ndims.m

@@ -2,11 +2,11 @@
 %% h5ndims(file, variable)
 % get number of dimensions of an HDF5 dataset
 %
-%% Inputs
+%%% Inputs
 % * file: data filename
 % * variable: name of variable inside file
 %
-%% Outputs
+%%% Outputs
 % * frank: number of variable dimensions (like Matlab ndims)
 
 arguments

+stdlib/+hdf5nc/h5save.m

@@ -4,7 +4,7 @@ function h5save(filename, varname, A, opts)
 %
 % parent folder (file directory) must already exist
 %
-%% Inputs
+%%% Inputs
 % * filename: data filename
 % * varname: variable name to save
 % * A: data to write