Skip to content

Improve style

Titre : Amélioration du Style et Factorisation des Fonctions pour le Projet SimProd

Description

Cette merge request apporte des améliorations significatives au code du projet SimProd. Les modifications se concentrent sur l'amélioration du style du code, la clarification de la documentation, et la factorisation des fonctions pour une meilleure maintenabilité et lisibilité.

Points Clés

  • Documentation Améliorée : Ajout et clarification des docstrings dans les modules plan.c et scenario.c, assurant une meilleure compréhension des fonctions.
  • Factorisation des Fonctions : Création de fonctions génériques pour gérer les opérations répétitives, simplifiant ainsi le code dans scenario.c.
  • Uniformisation du Style : Révision du style de codage pour garantir la cohérence à travers les modules.

Fichiers Modifiés

  1. plan.c - Ajout de docstrings et factorisation des fonctions de libération et de JSON.
  2. scenario.c - Introduction de fonctions génériques pour l'ajout et la libération des composants du scénario.
  3. README.md - Mise à jour pour inclure des informations plus détaillées sur l'exécution de l'exécutable et les dépendances.

Modifications Non Prévues

  • Correction de quelques incohérences mineures et erreurs typographiques dans la documentation et les commentaires.
  • Amélioration de la validation des données dans certaines fonctions, traitant des conversions entre types signés et non signés.

État de la Requête

Cette merge request est prête pour la revue et la validation. Les modifications sont testées et ne modifient pas le fonctionnement global du programme.

Appel à Action

Je sollicite la revue de cette merge request par l'équipe de développement. Vos commentaires et suggestions seront grandement appréciés pour assurer que ces améliorations correspondent bien aux standards et attentes du projet.

Merge request reports