Skip to content
Snippets Groups Projects
Commit 314fb58a authored by Arnauld Biganzoli's avatar Arnauld Biganzoli
Browse files

Update function name in README

parent a74efe17
No related branches found
No related tags found
No related merge requests found
...@@ -22,11 +22,12 @@ ...@@ -22,11 +22,12 @@
- [Étape 4 : Installer les dépendances](#étape-4--installer-les-dépendances) - [Étape 4 : Installer les dépendances](#étape-4--installer-les-dépendances)
- [Utilisation](#utilisation) - [Utilisation](#utilisation)
- [Documentation des fonctions du répertoire `src`](#documentation-des-fonctions-du-répertoire-src) - [Documentation des fonctions du répertoire `src`](#documentation-des-fonctions-du-répertoire-src)
- [🔹 display\_functions.py : `print_list_items_by_line(list_to_display, max_item_per_line=25)`](#-display_functionspy--print_list_items_by_linelist_to_display-max_item_per_line25) - [🔹 display\\table\_formatting.py : `print_list_items_by_line(list_to_display, max_item_per_line=25)`](#-displaytable_formattingpy--print_list_items_by_linelist_to_display-max_item_per_line25)
- [🔹 e\_series\_gererator.py : `get_available_e_series()`](#-e_series_gereratorpy--get_available_e_series) - [🔹 calculator\\e\_series\_gererator.py : `get_available_e_series()`](#-calculatore_series_gereratorpy--get_available_e_series)
- [🔹 e\_series\_gererator.py : `generate_e_series_resistor(start, end, serie)`](#-e_series_gereratorpy--generate_e_series_resistorstart-end-serie) - [🔹 calculator\\e\_series\_gererator.py : `generate_e_series_resistor(start, end, serie)`](#-calculatore_series_gereratorpy--generate_e_series_resistorstart-end-serie)
- [🔹 voltage\_divider\_calculator.py : `get_output_voltage_bridge(Vin, R1, R2)`](#-voltage_divider_calculatorpy--get_output_voltage_bridgevin-r1-r2) - [🔹 calculator\\e\_series\_values.py](#-calculatore_series_valuespy)
- [🔹 voltage\_divider\_calculator.py : `get_resistor_bridge_values(Vin, Vout, max_somme, e_serie, erreur_min)`](#-voltage_divider_calculatorpy--get_resistor_bridge_valuesvin-vout-max_somme-e_serie-erreur_min) - [🔹 calculator\\voltage\_divider\_calculator.py : `get_output_voltage_bridge(Vin, R1, R2)`](#-calculatorvoltage_divider_calculatorpy--get_output_voltage_bridgevin-r1-r2)
- [🔹 calculator\\voltage\_divider\_calculator.py : `get_resistor_bridge_values(Vin, Vout, max_somme, e_serie, erreur_min)`](#-calculatorvoltage_divider_calculatorpy--get_resistor_bridge_valuesvin-vout-max_somme-e_serie-erreur_min)
- [Conception de l'application graphique](#conception-de-lapplication-graphique) - [Conception de l'application graphique](#conception-de-lapplication-graphique)
- [Ouvert aux contributions](#ouvert-aux-contributions) - [Ouvert aux contributions](#ouvert-aux-contributions)
- [Licence](#licence) - [Licence](#licence)
...@@ -428,7 +429,7 @@ Vous pouvez modifier les valeurs d'entrée du programme pour tester différentes ...@@ -428,7 +429,7 @@ Vous pouvez modifier les valeurs d'entrée du programme pour tester différentes
## Documentation des fonctions du répertoire `src` ## Documentation des fonctions du répertoire `src`
#### 🔹 display_functions.py : `print_list_items_by_line(list_to_display, max_item_per_line=25)` #### 🔹 display\table_formatting.py : `print_list_items_by_line(list_to_display, max_item_per_line=25)`
Affiche les éléments d'une liste avec la méthode `print()` en regroupant un nombre maximum d'éléments par ligne. Affiche les éléments d'une liste avec la méthode `print()` en regroupant un nombre maximum d'éléments par ligne.
...@@ -436,13 +437,13 @@ Affiche les éléments d'une liste avec la méthode `print()` en regroupant un n ...@@ -436,13 +437,13 @@ Affiche les éléments d'une liste avec la méthode `print()` en regroupant un n
* **max_item_per_line:** Le nombre maximum d'éléments à afficher par ligne. * **max_item_per_line:** Le nombre maximum d'éléments à afficher par ligne.
* **Retour:** Aucun. * **Retour:** Aucun.
#### 🔹 e_series_gererator.py : `get_available_e_series()` #### 🔹 calculator\e_series_gererator.py : `get_available_e_series()`
Fonction pour obtenir la liste des séries de résistances normalisées disponibles. Fonction pour obtenir la liste des séries de résistances normalisées disponibles.
* **Retour:** Une liste des séries de résistances normalisées disponibles. * **Retour:** Une liste des séries de résistances normalisées disponibles.
#### 🔹 e_series_gererator.py : `generate_e_series_resistor(start, end, serie)` #### 🔹 calculator\e_series_gererator.py : `generate_e_series_resistor(start, end, serie)`
Fonction pour générer une série de résistances normalisées selon la norme CEI 60063. Fonction pour générer une série de résistances normalisées selon la norme CEI 60063.
...@@ -451,7 +452,11 @@ Fonction pour générer une série de résistances normalisées selon la norme C ...@@ -451,7 +452,11 @@ Fonction pour générer une série de résistances normalisées selon la norme C
* **serie:** La série E souhaitée (par exemple: "E24", "E48", "E96", etc.). * **serie:** La série E souhaitée (par exemple: "E24", "E48", "E96", etc.).
* **Retour:** La liste de valeurs de résistances normalisées dans la série spécifiée. * **Retour:** La liste de valeurs de résistances normalisées dans la série spécifiée.
#### 🔹 voltage_divider_calculator.py : `get_output_voltage_bridge(Vin, R1, R2)` #### 🔹 calculator\e_series_values.py
Contient les multiplicateurs de résistances des séries E selon la norme CEI 60063 dans la liste `e_series_multipliers`.
#### 🔹 calculator\voltage_divider_calculator.py : `get_output_voltage_bridge(Vin, R1, R2)`
Fonction pour calculer la tension de sortie d'un pont diviseur. Fonction pour calculer la tension de sortie d'un pont diviseur.
...@@ -460,7 +465,7 @@ Fonction pour calculer la tension de sortie d'un pont diviseur. ...@@ -460,7 +465,7 @@ Fonction pour calculer la tension de sortie d'un pont diviseur.
* **R2:** Valeur de la résistance R2 en ohms. * **R2:** Valeur de la résistance R2 en ohms.
* **Retour:** Tension de sortie du pont diviseur en volts. * **Retour:** Tension de sortie du pont diviseur en volts.
#### 🔹 voltage_divider_calculator.py : `get_resistor_bridge_values(Vin, Vout, max_somme, e_serie, erreur_min)` #### 🔹 calculator\voltage_divider_calculator.py : `get_resistor_bridge_values(Vin, Vout, max_somme, e_serie, erreur_min)`
Fonction pour calculer les valeurs de résistance d'un pont diviseur. Fonction pour calculer les valeurs de résistance d'un pont diviseur.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment