Getting started with a documentation format.

This commit is contained in:
Jeff 2026-01-11 15:28:15 -04:00
parent 142d2b7efb
commit ed3887f2dd
2 changed files with 15 additions and 2 deletions

View file

@ -1,4 +1,17 @@
va - Volt-Amps
================
This function
.. 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

View file

@ -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]