Small improvements in function descriptions

README.md

@@ -82,20 +82,20 @@ _PerfAndPubTools_ is bundled with the following functions, from lowest to
 highest-level of functionality:
 
 * [get_gtime] - Given a file containing the default output of the [GNU time]
-command, this function extracts the user, system and elapsed time in seconds, as
-well as the percentage of CPU usage.
+command, this function extracts the user, system and elapsed times in seconds,
+as well as the percentage of CPU usage.
 
-* [gather_times] - Load execution times from all files in a given folder. This
+* [gather_times] - Loads execution times from files in a given folder. This
 function uses [get_gtime] by default, but can be configured to use another
 function to load individual benchmark files with a different format.
 
-* [perfstats] - Determine mean times and respective standard deviations of a
+* [perfstats] - Determines mean times and respective standard deviations of a
 computational experiment using folders of files containing benchmarking results,
 optionally plotting a scalability graph if different setups correspond to
 different computational work sizes.
 
-* [speedup] - Determine speedups using folders of files containing benchmarking
-results, and optionally display speedups in a bar plot.
+* [speedup] - Determines speedups using folders of files containing benchmarking
+results, and optionally displays speedups in a bar plot.
 
 * [times_table] - Returns a matrix with useful contents for using in tables for
 publication, namely times (in seconds), absolute standard deviations (seconds),

README.mdpp

@@ -42,20 +42,20 @@ _PerfAndPubTools_ is bundled with the following functions, from lowest to
 highest-level of functionality:
 
 * [get_gtime] - Given a file containing the default output of the [GNU time]
-command, this function extracts the user, system and elapsed time in seconds, as
-well as the percentage of CPU usage.
+command, this function extracts the user, system and elapsed times in seconds,
+as well as the percentage of CPU usage.
 
-* [gather_times] - Load execution times from all files in a given folder. This
+* [gather_times] - Loads execution times from files in a given folder. This
 function uses [get_gtime] by default, but can be configured to use another
 function to load individual benchmark files with a different format.
 
-* [perfstats] - Determine mean times and respective standard deviations of a
+* [perfstats] - Determines mean times and respective standard deviations of a
 computational experiment using folders of files containing benchmarking results,
 optionally plotting a scalability graph if different setups correspond to
 different computational work sizes.
 
-* [speedup] - Determine speedups using folders of files containing benchmarking
-results, and optionally display speedups in a bar plot.
+* [speedup] - Determines speedups using folders of files containing benchmarking
+results, and optionally displays speedups in a bar plot.
 
 * [times_table] - Returns a matrix with useful contents for using in tables for
 publication, namely times (in seconds), absolute standard deviations (seconds),

gather_times.m

@@ -1,5 +1,5 @@
 function timings = gather_times(name, folder, files)
-% GATHER_TIMES Load execution times from all files in a given folder.
+% GATHER_TIMES Loads execution times from files in a given folder.
 %
 %   timings = GATHER_TIMES(name, folder, files)
 %

perfstats.m

@@ -1,6 +1,6 @@
 function [times, std_times, times_raw, fid, impl_legend, set_legend] ...
     = perfstats(do_plot, varargin)
-% PERFSTATS Determine mean times and respective standard deviations of a
+% PERFSTATS Determines mean times and respective standard deviations of a
 % computational experiment using folders of files containing benchmarking
 % results, optionally plotting a scalability graph if different setups
 % correspond to different computational work sizes.

speedup.m

@@ -1,7 +1,7 @@
 function [speedups, times, std_times, times_raw, fids, impl_legends, ...
     set_legends] = speedup(do_plot, compare, varargin)
-% SPEEDUP Determine speedups using folders of files containing benchmarking
-% results, and optionally display speedups in a bar plot.
+% SPEEDUP Determines speedups using folders of files containing
+% benchmarking results, and optionally displays speedups in a bar plot.
 %
 % [speedups, times, std_times, times_raw, fids, impl_legends, set_legends] 
 %   = SPEEDUP(do_plot, compare, varargin)