doc formatting

scivision · scivision · commit 7137c98bec18 · 2025-08-27T13:27:12.000-04:00
diff --git a/+stdlib/canonical.m b/+stdlib/canonical.m
@@ -11,6 +11,7 @@
 % * strict: if true, only return canonical path if it exists. If false, return normalized path if path does not exist.
 %%% Outputs
 % * c: canonical path, if determined
+% * b: backend used
 
 function [c, b] = canonical(p, strict)
 arguments
diff --git a/+stdlib/create_symlink.m b/+stdlib/create_symlink.m
@@ -1,9 +1,9 @@
 %% CREATE_SYMLINK create symbolic link
 %
-%% Inputs
+%%% inputs
 % * target: path to link to
 % * link: path to create link at
-%% Outputs
+%%% Outputs
 % * ok: true if successful
 % * b: backend used
 
diff --git a/+stdlib/device.m b/+stdlib/device.m
@@ -1,8 +1,8 @@
 %% DEVICE filesystem device index of path
 %
-%% Inputs
+%%% Inputs
 % * file: path to file
-%% Outputs
+%%% Outputs
 % * i: device index
 % * b: backend used
 
diff --git a/+stdlib/disk_available.m b/+stdlib/disk_available.m
@@ -2,9 +2,9 @@
 %
 % example:  stdlib.disk_available('/')
 %
-%% Inputs
+%%% inputs
 % * file: path to check
-%% Outputs
+%%% Outputs
 % * f: free disk space (bytes)
 % * b: backend used
 %
diff --git a/+stdlib/disk_capacity.m b/+stdlib/disk_capacity.m
@@ -2,9 +2,9 @@
 %
 % example:  stdlib.disk_capacity('/')
 %
-%% Inputs
+%%% inputs
 % * file: path to check
-%% Outputs
+%%% Outputs
 % * f: total disk capacity (bytes)
 % * b: backend used
 
diff --git a/+stdlib/filesystem_type.m b/+stdlib/filesystem_type.m
@@ -2,10 +2,10 @@
 %
 % example outputs: NTFS, ext4, apfs, ...
 %
-%% Inputs
+%%% inputs
 % * file: path to check
 % * backend: backend to use
-%% Outputs
+%%% Outputs
 % * t: filesystem type
 % * b: backend used
 
diff --git a/+stdlib/get_permissions.m b/+stdlib/get_permissions.m
@@ -2,10 +2,10 @@
 %
 % output is char like 'rwxrwxr--'
 %
-%% Inputs
+%%% inputs
 % * file: path to check
 % * backend: backend to use
-%% Outputs
+%%% Outputs
 % * p: permissions string
 % * b: backend used
 
diff --git a/+stdlib/get_shell.m b/+stdlib/get_shell.m
@@ -1,6 +1,6 @@
 %% GET_SHELL full path to currently running shell
 %
-%% Outputs
+%%% Outputs
 % * s: full path to currently running shell
 % * b: backend used
 
diff --git a/+stdlib/get_uid.m b/+stdlib/get_uid.m
@@ -1,6 +1,6 @@
 %% GET_UID tell UID (numeric) of current user
 %
-%% Outputs
+%%% Outputs
 % * n: UID of current user
 % * b: backend used
 
diff --git a/+stdlib/get_username.m b/+stdlib/get_username.m
@@ -1,6 +1,6 @@
 %% GET_USERNAME tell username of current user
 %
-%% Outputs
+%%% Outputs
 % * n: username of current user
 % * b: backend used
 
diff --git a/+stdlib/hard_link_count.m b/+stdlib/hard_link_count.m
@@ -1,8 +1,8 @@
 %% HARD_LINK_COUNT get the number of hard links to a file
 %
-%% Inputs
+%%% inputs
 % * file: path to check
-%% Outputs
+%%% Outputs
 % * c: number of hard links
 % * b: backend used
 %% Java backend references:
diff --git a/+stdlib/hostname.m b/+stdlib/hostname.m
@@ -1,6 +1,6 @@
 %% HOSTNAME get hostname of local machine
 %
-%% Outputs
+%%% Outputs
 % * n: hostname of local machine
 % * b: backend used
 %
diff --git a/+stdlib/inode.m b/+stdlib/inode.m
@@ -1,8 +1,8 @@
 %% INODE filesystem inode of path
 %
-%% Inputs
+%%% inputs
 % * file: path to check
-%% Outputs
+%%% Outputs
 % * i: inode number
 % * b: backend used
 
diff --git a/+stdlib/is_admin.m b/+stdlib/is_admin.m
@@ -1,6 +1,6 @@
 %% IS_ADMIN is the process run as root / admin
 %
-%% Outputs
+%%% Outputs
 % * ok: true if process is run as root / admin
 % * b: backend used
 
diff --git a/+stdlib/is_char_device.m b/+stdlib/is_char_device.m
@@ -3,10 +3,10 @@
 % e.g. NUL, /dev/null
 % false if file does not exist
 %
-%% Inputs
+%%% inputs
 % * file: path to check
 % * backend: backend to use
-%% Outputs
+%%% Outputs
 % * ok: true if path is a character device
 % * b: backend used
 %
diff --git a/+stdlib/is_exe.m b/+stdlib/is_exe.m
@@ -1,9 +1,9 @@
 %% IS_EXE is file executable
 % does not check if the file is actually a binary executable
 %
-%% Inputs
+%%% inputs
 % file: path to check
-%% Outputs
+%%% Outputs
 % ok: true if path is a file and has executable permissions
 
 function ok = is_exe(file)
diff --git a/+stdlib/is_mount.m b/+stdlib/is_mount.m
@@ -1,9 +1,9 @@
 %% IS_MOUNT is filepath a mount path
 %
-%% Inputs
+%%% inputs
 % * file: path to check
 % * backend: backend to use
-%% Outputs
+%%% Outputs
 % * ok: true if path is a mount point
 % * b: backend used
 %
diff --git a/+stdlib/is_readable.m b/+stdlib/is_readable.m
@@ -2,7 +2,7 @@
 %
 %%% Inputs
 % file: single path string
-%% Outputs
+%%% Outputs
 % ok: true if file is readable
 
 function ok = is_readable(file)
diff --git a/+stdlib/is_removable.m b/+stdlib/is_removable.m
@@ -1,11 +1,11 @@
 %% IS_REMOVABLE - Check if a file path is on a removable drive
 % Not necessarily perfectly reliable at detection, but works for most cases.
 %
-%% Inputs
+%%% inputs
 % * file: path to check
 % * backend: backend to use
 %
-%% Outputs
+%%% Outputs
 % * ok: true if path is on a removable drive
 % * b: backend used
 
diff --git a/+stdlib/is_rosetta.m b/+stdlib/is_rosetta.m
@@ -1,7 +1,7 @@
 %% IS_ROSETTA on Apple Silicon via Rosetta
 %
 % true if Matlab on Apple Silicon CPU is built for Intel x86_64
-%% Outputs
+%%% Outputs
 % * r: true if running under Rosetta
 % * b: backend used
 %
diff --git a/+stdlib/is_symlink.m b/+stdlib/is_symlink.m
@@ -1,9 +1,9 @@
 %% IS_SYMLINK is path a symbolic link
 %
-%% Inputs
+%%% inputs
 % * file: path to check
 % * backend: backend to use
-%% Outputs
+%%% Outputs
 % * ok: true if path is a symbolic link
 % * b: backend used
 
diff --git a/+stdlib/is_writable.m b/+stdlib/is_writable.m
@@ -2,7 +2,7 @@
 %
 %%% Inputs
 % * file: path to file or folder
-%% Outputs
+%%% Outputs
 % * ok: true if file is writable
 
 function ok = is_writable(file)
diff --git a/+stdlib/os_version.m b/+stdlib/os_version.m
@@ -3,7 +3,7 @@
 % Note: for Windows 11, need new-enough Java version to show Windows 11
 % instead of Windows 10.
 %
-%% Outputs
+%%% Outputs
 % * os: operating system name
 % * version: operating system version
 % * b: backend used
diff --git a/+stdlib/parent.m b/+stdlib/parent.m
@@ -1,8 +1,8 @@
 %% PARENT parent directory of path
 %
-%% Inputs
+%%% inputs
 % * file: path to file or folder
-%% Outputs
+%%% Outputs
 % * par: parent directory of path
 %% Examples:
 % stdlib.parent("a/b/c") == "a/b"
diff --git a/+stdlib/read_symlink.m b/+stdlib/read_symlink.m
@@ -3,10 +3,10 @@
 % empty string if path is not a symlink
 % always of string class in Matlab
 %
-%% Inputs
+%%% inputs
 % * file: path to symbolic link
 % * backend: backend to use
-%% Outputs
+%%% Outputs
 % * r: target of symbolic link
 % * b: backend used
 
diff --git a/+stdlib/samepath.m b/+stdlib/samepath.m
@@ -9,10 +9,10 @@
 %
 % Ref: https://devblogs.microsoft.com/oldnewthing/20220128-00/?p=106201
 %
-%% Inputs
+%%% inputs
 % * path1, path2: paths to compare
 % * backend: backend to use, default is "python"
-%% Outputs
+%%% Outputs
 % * ok: true if paths are the same
 % * b: backend used
 
diff --git a/+stdlib/toolbox_used.m b/+stdlib/toolbox_used.m
@@ -1,8 +1,8 @@
 %% TOOLBOX_USED list all Matlab toolboxes used by all functions in pkgPath
 %
-%% Inputs
+%%% inputs
 % * pkgPath: path to user namespace or file. Example: "+stdlib" or "stdlib.cpu_arch"
-%% Outputs
+%%% Outputs
 % * tbxMathworks: Mathworks toolbox names used
 % * funUser: all user function files under pkgPath
 
@@ -17,4 +17,4 @@
 
 funUser = string(user).';
 
-end
+end
diff --git a/+stdlib/version_atleast.m b/+stdlib/version_atleast.m
@@ -2,10 +2,10 @@
 % compare two string verions: major.minor.rev.patch
 % numeric portions only.
 %
-%% Inputs
+%%% inputs
 % * in: version to examine (string)
 % * ref: version to compare against (at least this version is true)
-%% Outputs
+%%% Outputs
 % * r: logical
 
 function r = version_atleast(in, ref)

Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,9 @@`
`2`	`2`	`%`
`3`	`3`	`% example: stdlib.disk_available('/')`
`4`	`4`	`%`
`5`		`-%% Inputs`
	`5`	`+%%% inputs`
`6`	`6`	`% * file: path to check`
`7`		`-%% Outputs`
	`7`	`+%%% Outputs`
`8`	`8`	`% * f: free disk space (bytes)`
`9`	`9`	`% * b: backend used`
`10`	`10`	`%`
Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,9 @@`
`2`	`2`	`%`
`3`	`3`	`% example: stdlib.disk_capacity('/')`
`4`	`4`	`%`
`5`		`-%% Inputs`
	`5`	`+%%% inputs`
`6`	`6`	`% * file: path to check`
`7`		`-%% Outputs`
	`7`	`+%%% Outputs`
`8`	`8`	`% * f: total disk capacity (bytes)`
`9`	`9`	`% * b: backend used`
`10`	`10`
Original file line number	Diff line number	Diff line change
`@@ -2,10 +2,10 @@`
`2`	`2`	`%`
`3`	`3`	`% example outputs: NTFS, ext4, apfs, ...`
`4`	`4`	`%`
`5`		`-%% Inputs`
	`5`	`+%%% inputs`
`6`	`6`	`% * file: path to check`
`7`	`7`	`% * backend: backend to use`
`8`		`-%% Outputs`
	`8`	`+%%% Outputs`
`9`	`9`	`% * t: filesystem type`
`10`	`10`	`% * b: backend used`
`11`	`11`
Original file line number	Diff line number	Diff line change
`@@ -2,10 +2,10 @@`
`2`	`2`	`%`
`3`	`3`	`% output is char like 'rwxrwxr--'`
`4`	`4`	`%`
`5`		`-%% Inputs`
	`5`	`+%%% inputs`
`6`	`6`	`% * file: path to check`
`7`	`7`	`% * backend: backend to use`
`8`		`-%% Outputs`
	`8`	`+%%% Outputs`
`9`	`9`	`% * p: permissions string`
`10`	`10`	`% * b: backend used`
`11`	`11`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`%% GET_SHELL full path to currently running shell`
`2`	`2`	`%`
`3`		`-%% Outputs`
	`3`	`+%%% Outputs`
`4`	`4`	`% * s: full path to currently running shell`
`5`	`5`	`% * b: backend used`
`6`	`6`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`%% GET_UID tell UID (numeric) of current user`
`2`	`2`	`%`
`3`		`-%% Outputs`
	`3`	`+%%% Outputs`
`4`	`4`	`% * n: UID of current user`
`5`	`5`	`% * b: backend used`
`6`	`6`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`%% GET_USERNAME tell username of current user`
`2`	`2`	`%`
`3`		`-%% Outputs`
	`3`	`+%%% Outputs`
`4`	`4`	`% * n: username of current user`
`5`	`5`	`% * b: backend used`
`6`	`6`