From e98f0aa1bfb557a66972087a9bfcabd7e9cf4b6f Mon Sep 17 00:00:00 2001
From: Thomas Lambert <t.lambert@uliege.be>
Date: Wed, 15 Mar 2023 14:30:29 +0100
Subject: [PATCH] doc(utils): add spacing effect

---
 +af_tools/+utils/spacedvector.m | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/+af_tools/+utils/spacedvector.m b/+af_tools/+utils/spacedvector.m
index d0a7d34..eed470d 100644
--- a/+af_tools/+utils/spacedvector.m
+++ b/+af_tools/+utils/spacedvector.m
@@ -1,5 +1,12 @@
 function vect = spacedvector(spacing, nPoints)
     % SPACEDVECTOR Returns a vector based on chosen spacing and number of points
+    %
+    % Spacing:
+    %   - linear     : points spaced linearily
+    %   - halfcosine : more dense at beginning and end of vector
+    %   - cosine     : more dense at the beginning and more spaced out at the end
+    %   - sine       : more dense at the end and more spaced out at the beginning
+    %
     % -----
     % (c) Copyright 2022-2023 University of Liege
     % Author: Thomas Lambert <t.lambert@uliege.be>
-- 
GitLab