[retro-gtk/core-fixes: 3/9] core: Improve the runahead property documentation

[Adrien Plazas <aplazas src gnome org>]

commit d1a691bddc55eda6c647b589892c32b4c9ec5991
Author: Adrien Plazas <kekun plazas laposte net>
Date:   Sun Feb 16 08:14:37 2020 +0100

    core: Improve the runahead property documentation

 retro-gtk/retro-core.c    | 9 ++++++++-
 retro-runner/retro-core.c | 9 ++++++++-
 2 files changed, 16 insertions(+), 2 deletions(-)
---
diff --git a/retro-gtk/retro-core.c b/retro-gtk/retro-core.c
index 5be9388..fad83ae 100644
--- a/retro-gtk/retro-core.c
+++ b/retro-gtk/retro-core.c
@@ -441,7 +441,14 @@ retro_core_class_init (RetroCoreClass *klass)
   /**
    * RetroCore:runahead:
    *
-   * The number of frame to run ahead of time.
+   * The number of frames to run ahead of time. This allows to know in advance
+   * what should happen in the given number of frames, allowing to react in
+   * advance.
+   *
+   * Note that this is resource intensive as the core will be iterated over
+   * multiple times for each perceived iteration. In order to work, this
+   * requires the cores to properly support serialization, otherwise the
+   * behavior is undefined.
    */
   properties[PROP_RUNAHEAD] =
     g_param_spec_uint ("runahead",
diff --git a/retro-runner/retro-core.c b/retro-runner/retro-core.c
index 294a7a6..fd74472 100644
--- a/retro-runner/retro-core.c
+++ b/retro-runner/retro-core.c
@@ -388,7 +388,14 @@ retro_core_class_init (RetroCoreClass *klass)
   /**
    * RetroCore:runahead:
    *
-   * The number of frame to run ahead of time.
+   * The number of frames to run ahead of time. This allows to know in advance
+   * what should happen in the given number of frames, allowing to react in
+   * advance.
+   *
+   * Note that this is resource intensive as the core will be iterated over
+   * multiple times for each perceived iteration. In order to work, this
+   * requires the cores to properly support serialization, otherwise the
+   * behavior is undefined.
    */
   properties[PROP_RUNAHEAD] =
     g_param_spec_uint ("runahead",