Skip to content

Commit 3dac0b7

Browse files
committed
Changed spikesafe_python_lib_docs.Precision function comments return type to string as this is what the function returns
1 parent 708b19a commit 3dac0b7

File tree

8 files changed

+8
-8
lines changed
  • spikesafe_python_lib_docs/Precision
    • get_precise_compliance_voltage_command_argument
    • get_precise_current_command_argument
    • get_precise_duty_cycle_command_argument
    • get_precise_pulse_width_offset_command_argument
    • get_precise_time_command_argument
    • get_precise_time_microseconds_command_argument
    • get_precise_voltage_protection_ramp_dt_command_argument
    • get_precise_voltage_protection_ramp_dv_command_argument

8 files changed

+8
-8
lines changed

spikesafe_python_lib_docs/Precision/get_precise_compliance_voltage_command_argument/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ compliance_voltage [float](https://docs.python.org/3/library/functions.html#floa
1010
Compliance voltage to be sent to SpikeSafe
1111

1212
### Returns
13-
[float](https://docs.python.org/3/library/functions.html#float)
13+
[string](https://docs.python.org/3/library/string.html)
1414
Compliance voltage command argument with optimal precision
1515

1616
### Examples

spikesafe_python_lib_docs/Precision/get_precise_current_command_argument/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ current_amps [float](https://docs.python.org/3/library/functions.html#float)
1010
Current in amps to be sent to SpikeSafe
1111

1212
### Returns
13-
[float](https://docs.python.org/3/library/functions.html#float)
13+
[string](https://docs.python.org/3/library/string.html)
1414
Current in amps command argument with optimal precision
1515

1616
### Examples

spikesafe_python_lib_docs/Precision/get_precise_duty_cycle_command_argument/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ duty_cycle [float](https://docs.python.org/3/library/functions.html#float)
1010
Duty cycle to be sent to SpikeSafe
1111

1212
### Returns
13-
[float](https://docs.python.org/3/library/functions.html#float)
13+
[string](https://docs.python.org/3/library/string.html)
1414
Duty cycle command argument with optimal precision
1515

1616
### Examples

spikesafe_python_lib_docs/Precision/get_precise_pulse_width_offset_command_argument/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ pulse_width_offset [float](https://docs.python.org/3/library/functions.html#floa
1010
Pulse width offset to be sent to SpikeSafe
1111

1212
### Returns
13-
[float](https://docs.python.org/3/library/functions.html#float)
13+
[string](https://docs.python.org/3/library/string.html)
1414
Pulse width offset command argument with optimal precision

spikesafe_python_lib_docs/Precision/get_precise_time_command_argument/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ time_seconds [float](https://docs.python.org/3/library/functions.html#float)
1010
Time in seconds to be sent to SpikeSafe
1111

1212
### Returns
13-
[float](https://docs.python.org/3/library/functions.html#float)
13+
[string](https://docs.python.org/3/library/string.html)
1414
Time in seconds command argument with optimal precision
1515

1616
### Examples

spikesafe_python_lib_docs/Precision/get_precise_time_microseconds_command_argument/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ time_microseconds [float](https://docs.python.org/3/library/functions.html#float
1010
Time in microseconds to be sent to SpikeSafe
1111

1212
### Returns
13-
[float](https://docs.python.org/3/library/functions.html#float)
13+
[string](https://docs.python.org/3/library/string.html)
1414
Time in microseconds command argument with optimal precision
1515

1616
### Examples

spikesafe_python_lib_docs/Precision/get_precise_voltage_protection_ramp_dt_command_argument/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ voltage_protection_ramp_dt [float](https://docs.python.org/3/library/functions.h
1010
Voltage ramp detection dt to be sent to SpikeSafe
1111

1212
### Returns
13-
[float](https://docs.python.org/3/library/functions.html#float)
13+
[string](https://docs.python.org/3/library/string.html)
1414
Voltage ramp detection dt command argument with optimal precision

spikesafe_python_lib_docs/Precision/get_precise_voltage_protection_ramp_dv_command_argument/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ voltage_protection_ramp_dv [float](https://docs.python.org/3/library/functions.h
1010
Voltage ramp detection dV to be sent to SpikeSafe
1111

1212
### Returns
13-
[float](https://docs.python.org/3/library/functions.html#float)
13+
[string](https://docs.python.org/3/library/string.html)
1414
Voltage ramp detection dV command argument with optimal precision

0 commit comments

Comments
 (0)