Update API documentation and French translations for clarity and consistency

Author: PierreRaybaut

doc/api/index.rst

@@ -3,10 +3,7 @@
 API
 ===
 
-The public Application Programming Interface (API) of DataLab offers a set of
-functions to access the DataLab features. Those functions are available in various
-submodules of the `datalab` package. The following table lists the available submodules
-and their purpose:
+The public Application Programming Interface (API) of DataLab offers a set of functions to access the DataLab features. Those functions are available in various submodules of the `sigima` and `datalab` packages. The `sigima` package is the computation engine of DataLab, while the `datalab` package provides the interface to access the application features. The following table lists the available submodules and their purpose:
 
 .. list-table::
     :header-rows: 1
@@ -16,16 +13,16 @@ and their purpose:
       - Purpose
 
     * - :mod:`sigima.tools`
-      - Algorithms for data analysis, which operates on NumPy arrays
+      - Algorithms for data analysis (operating on NumPy arrays) which purpose is to fill in the gaps of common scientific libraries (NumPy, SciPy, scikit-image, etc.), offering consistent tools for computation functions (see :mod:`sigima.proc`)
 
     * - :mod:`sigima.params`
-      - Convenience module to access the DataLab sets of parameters (instances of :class:`guidata.dataset.DataSet` objects)
+      - Sets of parameters for configuring computation functions (these parameters are instances of :class:`guidata.dataset.DataSet` objects)
 
     * - :mod:`sigima.objects`
-      - Convenience module to access the DataLab objects (:class:`sigima.objects.SignalObj` or :class:`sigima.objects.ImageObj`) and related functions
+      - Object model for signals and images (:class:`sigima.objects.SignalObj` and :class:`sigima.objects.ImageObj`) and related functions
 
     * - :mod:`sigima.proc`
-      - Computation functions, which operate on DataLab objects (:class:`sigima.objects.SignalObj` or :class:`sigima.objects.ImageObj`)
+      - Computation functions, which operate on signal and image objects (:class:`sigima.objects.SignalObj` or :class:`sigima.objects.ImageObj`)
 
     * - :mod:`datalab.proxy`
       - Proxy objects to access the DataLab interface from a Python script or a remote application

doc/locale/fr/LC_MESSAGES/api/index.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: DataLab \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2025-03-20 16:25+0100\n"
+"POT-Creation-Date: 2025-07-08 17:00+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language: fr\n"
@@ -28,8 +28,8 @@ msgstr "Fonctionnalités internes :"
 msgid "API"
 msgstr "API"
 
-msgid "The public Application Programming Interface (API) of DataLab offers a set of functions to access the DataLab features. Those functions are available in various submodules of the `datalab` package. The following table lists the available submodules and their purpose:"
-msgstr "L'interface de programmation d'application (API) publique de DataLab offre un ensemble de fonctions pour accéder aux fonctionnalités de DataLab. Ces fonctions sont disponibles dans divers sous-modules du package `datalab`. Le tableau suivant répertorie les sous-modules disponibles et leurs contenus respectifs :"
+msgid "The public Application Programming Interface (API) of DataLab offers a set of functions to access the DataLab features. Those functions are available in various submodules of the `sigima` and `datalab` packages. The `sigima` package is the computation engine of DataLab, while the `datalab` package provides the interface to access the application features. The following table lists the available submodules and their purpose:"
+msgstr "L'interface de programmation d'application (API) publique de DataLab offre un ensemble de fonctions pour accéder aux fonctionnalités de DataLab. Ces fonctions sont disponibles dans divers sous-modules des paquets `sigima` et `datalab`. Le paquet `sigima` est le moteur de calcul de DataLab, tandis que le paquet `datalab` fournit l'interface pour accéder aux fonctionnalités de l'application. Le tableau suivant répertorie les sous-modules disponibles et leur objectif :"
 
 msgid "Submodule"
 msgstr "Sous-module"
@@ -40,26 +40,26 @@ msgstr "Contenu"
 msgid ":mod:`sigima.tools`"
 msgstr ""
 
-msgid "Algorithms for data analysis, which operates on NumPy arrays"
-msgstr "Algorithmes pour l'analyse de données, qui opèrent sur des tableaux NumPy"
+msgid "Algorithms for data analysis (operating on NumPy arrays) which purpose is to fill in the gaps of common scientific libraries (NumPy, SciPy, scikit-image, etc.), offering consistent tools for computation functions (see :mod:`sigima.proc`)"
+msgstr "Algorithmes pour l'analyse de données (opérant sur des tableaux NumPy) dont le but est de combler les lacunes des bibliothèques scientifiques courantes (NumPy, SciPy, scikit-image, etc.), offrant des outils cohérents pour les fonctions de calcul (voir :mod:`sigima.proc`)"
 
 msgid ":mod:`sigima.params`"
 msgstr ""
 
-msgid "Convenience module to access the DataLab sets of parameters (instances of :class:`guidata.dataset.DataSet` objects)"
-msgstr "Module de commodité pour accéder aux ensembles de paramètres DataLab (instances d'objets :class:`guidata.dataset.DataSet`)"
+msgid "Sets of parameters for configuring computation functions (these parameters are instances of :class:`guidata.dataset.DataSet` objects)"
+msgstr "Ensembles de paramètres pour configurer les fonctions de calcul (ces paramètres sont des instances d'objets :class:`guidata.dataset.DataSet`)"
 
 msgid ":mod:`sigima.objects`"
 msgstr ""
 
-msgid "Convenience module to access the DataLab objects (:class:`sigima.objects.SignalObj` or :class:`sigima.objects.ImageObj`) and related functions"
-msgstr "Module de commodité pour accéder aux objets DataLab (:class:`sigima.objects.SignalObj` ou :class:`sigima.objects.ImageObj`) et fonctions associées"
+msgid "Object model for signals and images (:class:`sigima.objects.SignalObj` and :class:`sigima.objects.ImageObj`) and related functions"
+msgstr "Modèle objet pour les signaux et les images (:class:`sigima.objects.SignalObj` et :class:`sigima.objects.ImageObj`) et fonctions associées"
 
 msgid ":mod:`sigima.proc`"
 msgstr ""
 
-msgid "Computation functions, which operate on DataLab objects (:class:`sigima.objects.SignalObj` or :class:`sigima.objects.ImageObj`)"
-msgstr "Fonctions de calcul, qui opèrent sur les objets DataLab (:class:`sigima.objects.SignalObj` ou :class:`sigima.objects.ImageObj`)"
+msgid "Computation functions, which operate on signal and image objects (:class:`sigima.objects.SignalObj` or :class:`sigima.objects.ImageObj`)"
+msgstr "Fonctions de calcul, qui opèrent sur des objets signaux et images (:class:`sigima.objects.SignalObj` ou :class:`sigima.objects.ImageObj`)"
 
 msgid ":mod:`datalab.proxy`"
 msgstr ""