update README API doc

todbot · todbot · commit ffb6c4c4dba1 · 2020-01-06T12:17:47.000-08:00
diff --git a/README.md b/README.md
@@ -264,7 +264,7 @@ blink1.blink1.Blink1 = class Blink1
  |  
  |  fade_to_rgb_uncorrected(self, fade_milliseconds, red, green, blue, ledn=0)
  |      Command blink(1) to fade to RGB color, no color correction applied.
- |      :throws: Blink1ConnectionFailed if blink(1) is disconnected
+ |      :raises: Blink1ConnectionFailed if blink(1) is disconnected
  |  
  |  get_serial_number(self)
  |      Get blink(1) serial number
@@ -343,7 +343,7 @@ blink1.blink1.Blink1 = class Blink1
  |      Write command to blink(1), low-level internal use
  |      Send USB Feature Report 0x01 to blink(1) with 8-byte payload
  |      Note: arg 'buf' must be 8 bytes or bad things happen
- |      :return: number of bytes written or -1 if failure
+ |      :raises: Blink1ConnectionFailed if blink(1) is disconnected
  |  
  |  write_pattern_line(self, step_milliseconds, color, pos, ledn=0)
  |      Write a color & step time color pattern line to RAM

Original file line number	Diff line number	Diff line change
`@@ -264,7 +264,7 @@ blink1.blink1.Blink1 = class Blink1`
`264`	`264`	`\|`
`265`	`265`	`\| fade_to_rgb_uncorrected(self, fade_milliseconds, red, green, blue, ledn=0)`
`266`	`266`	`\| Command blink(1) to fade to RGB color, no color correction applied.`
`267`		`- \| :throws: Blink1ConnectionFailed if blink(1) is disconnected`
	`267`	`+ \| :raises: Blink1ConnectionFailed if blink(1) is disconnected`
`268`	`268`	`\|`
`269`	`269`	`\| get_serial_number(self)`
`270`	`270`	`\| Get blink(1) serial number`
`@@ -343,7 +343,7 @@ blink1.blink1.Blink1 = class Blink1`
`343`	`343`	`\| Write command to blink(1), low-level internal use`
`344`	`344`	`\| Send USB Feature Report 0x01 to blink(1) with 8-byte payload`
`345`	`345`	`\| Note: arg 'buf' must be 8 bytes or bad things happen`
`346`		`- \| :return: number of bytes written or -1 if failure`
	`346`	`+ \| :raises: Blink1ConnectionFailed if blink(1) is disconnected`
`347`	`347`	`\|`
`348`	`348`	`\| write_pattern_line(self, step_milliseconds, color, pos, ledn=0)`
`349`	`349`	`\| Write a color & step time color pattern line to RAM`