Corrects errors in returning constant labels (#1735)

oyama · web-flow · commit 333974fd6cb3 · 2024-06-21T14:24:44.000-05:00
diff --git a/src/rp2_common/pico_flash/include/pico/flash.h b/src/rp2_common/pico_flash/include/pico/flash.h
@@ -78,7 +78,7 @@ bool flash_safe_execute_core_deinit(void);
  * \param enter_exit_timeout_ms the timeout for each of the enter/exit phases when coordinating with the other core
  *
  * \return PICO_OK on success (the function will have been called).
- *         PICO_TIMEOUT on timeout (the function may have been called).
+ *         PICO_ERROR_TIMEOUT on timeout (the function may have been called).
  *         PICO_ERROR_NOT_PERMITTED if safe execution is not possible (the function will not have been called).
  *         PICO_ERROR_INSUFFICIENT_RESOURCES if the method fails due to dynamic resource exhaustion (the function will not have been called)
  * \note if \ref PICO_FLASH_ASSERT_ON_UNSAFE is 1, this function will assert in debug mode vs returning

Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ bool flash_safe_execute_core_deinit(void);`
`78`	`78`	`* \param enter_exit_timeout_ms the timeout for each of the enter/exit phases when coordinating with the other core`
`79`	`79`	`*`
`80`	`80`	`* \return PICO_OK on success (the function will have been called).`
`81`		`- * PICO_TIMEOUT on timeout (the function may have been called).`
	`81`	`+ * PICO_ERROR_TIMEOUT on timeout (the function may have been called).`
`82`	`82`	`* PICO_ERROR_NOT_PERMITTED if safe execution is not possible (the function will not have been called).`
`83`	`83`	`* PICO_ERROR_INSUFFICIENT_RESOURCES if the method fails due to dynamic resource exhaustion (the function will not have been called)`
`84`	`84`	`* \note if \ref PICO_FLASH_ASSERT_ON_UNSAFE is 1, this function will assert in debug mode vs returning`