Browse Source

More notes in the problems section of the documentation

Yentl Van Tendeloo 5 years ago
parent
commit
6122600f36
1 changed files with 6 additions and 5 deletions
  1. 6 5
      doc/problems.rst

+ 6 - 5
doc/problems.rst

@@ -1,16 +1,17 @@
 Common problems and solutions
 =============================
 
-List set of common problems and their solution
+List set of common problems and their solution.
+Most functions are however rather safe and should return an exception in the wrapper, instead of crashing the kernel.
+Note that even if the MvK crashes with such an error as mentioned below, this only breaks the violating task and all other tasks are left unharmed.
+As such, it is possible for a user to log in again on a different task, although there is no continuation.
 
 TODO: body_id is None
 ---------------------
 
-Missing definition after declaration
+This error likely means that a function is called that was never defined: the declaration was found, but the definition is empty.
 
 TODO: None has no length
 ------------------------
 
-Operations done on a failed object, such as a dictionary read on a non-existing element
-
-TODO: find more
+Operations done on an error value, such as a dictionary read on a non-existing element