From 9ff4d3e28c88867e62c48c2c459727abff812f4d Mon Sep 17 00:00:00 2001
From: Wissam Boussella <wissam.boussella@cea.fr>
Date: Thu, 20 Mar 2025 11:32:37 +0100
Subject: [PATCH] docstring : Back to the future

---
 include/aidge/data/DataFormat.hpp | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/include/aidge/data/DataFormat.hpp b/include/aidge/data/DataFormat.hpp
index 64a996501..d89eb24cd 100644
--- a/include/aidge/data/DataFormat.hpp
+++ b/include/aidge/data/DataFormat.hpp
@@ -88,6 +88,11 @@ DataFormatTranspose getPermutationMapping(const DataFormat& src, const DataForma
  *
  * This function computes the new data format after transposing a tensor.
  *
+ * It follows these steps:
+ *   1. Retrieves the permutation mapping from the input format.
+ *   2. Applies the given output dimensions order to compute the new permutation.
+ *   3. Identifies the corresponding data format after applying the new permutation.
+ * 
  * @param inputDataFormat The data format of the input tensor.
  * @param outputDimsOrder The permutation applied to the input tensor's dimensions.
  * @return DataFormat The computed output data format after applying the permutation.
-- 
GitLab