From ed3887f2dd0d9343967dbc45e6f0252591a8723a Mon Sep 17 00:00:00 2001 From: Jeff Date: Sun, 11 Jan 2026 15:28:15 -0400 Subject: [PATCH] Getting started with a documentation format. --- docs/source/general/va.rst | 15 ++++++++++++++- jepl/jepl_circuits.py | 2 +- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/source/general/va.rst b/docs/source/general/va.rst index 0f0904e..016ebf3 100644 --- a/docs/source/general/va.rst +++ b/docs/source/general/va.rst @@ -1,4 +1,17 @@ va - Volt-Amps ================ -This function \ No newline at end of file + +.. function:: va(voltage, current, phases=3) + + :module: JEPL.general + :param voltage: The voltage of the circuit + :type voltage: float + :param current: The current of the circuit + :type current: float + :returns: volt-Amps in VA + :rtype: float + + Describe the function + + diff --git a/jepl/jepl_circuits.py b/jepl/jepl_circuits.py index c066718..118df0d 100644 --- a/jepl/jepl_circuits.py +++ b/jepl/jepl_circuits.py @@ -110,7 +110,7 @@ def voltage_drop(voltage, current, conductor_size, length, num_phase = 3, materi #print(current) #print(length) voltage_drop = K * F * current * length / 1000 - percent_voltage_drop = (voltage_drop / voltage) + percent_voltage_drop = (voltage_drop / voltage) return [voltage_drop, percent_voltage_drop]