Browse Source

fix doc according to https://github.com/pocketpy/pocketpy/pull/366

blueloveTH 9 months ago
parent
commit
b0c1fe5b13
1 changed files with 2 additions and 1 deletions
  1. 2 1
      include/pocketpy/pocketpy.h

+ 2 - 1
include/pocketpy/pocketpy.h

@@ -90,7 +90,8 @@ enum py_CompileMode { EXEC_MODE, EVAL_MODE, SINGLE_MODE };
 
 
 /// Initialize pocketpy and the default VM.
 /// Initialize pocketpy and the default VM.
 PK_API void py_initialize();
 PK_API void py_initialize();
-/// Finalize pocketpy and free all VMs.
+/// Finalize pocketpy and free all VMs. This opearation is irreversible.
+/// After this call, you cannot use any function from this header anymore.
 PK_API void py_finalize();
 PK_API void py_finalize();
 /// Get the current VM index.
 /// Get the current VM index.
 PK_API int py_currentvm();
 PK_API int py_currentvm();