Skip to content

Commit b3717be

Browse files
committed
pbio/os: Clarify departure from Contiki.
Replace specific note about differences with generic one as this is not the full picture.
1 parent 8a52837 commit b3717be

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

  • lib/pbio/include/pbio

lib/pbio/include/pbio/os.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@
4848
*
4949
* The code in this file stems from Contiki's implementation of protothreads as
5050
* listed above. This adaptation changes the API to work better with Pybricks.
51+
*
52+
* Caution: it is conceptually very similar to Contiki but it cannot be used as
53+
* a drop-in replacement.
5154
*/
5255

5356
#ifndef _PBIO_OS_H_
@@ -149,8 +152,6 @@ struct _pbio_os_process_t {
149152
* This macro is used for declaring that a protothread ends. It must
150153
* always be used together with a matching ASYNC_BEGIN() macro.
151154
*
152-
* NB: In contrast to Contiki, this does not call ASYNC_INIT() before exiting.
153-
*
154155
* @param [in] err Error code to return.
155156
*/
156157
#define ASYNC_END(err) PB_LC_END(); return err; }

0 commit comments

Comments
 (0)