Updated docs. FIx phaserjs#4229

photonstorm · photonstorm · commit 9972594e60c9 · 2020-10-17T12:11:35.000+01:00
diff --git a/src/core/typedefs/FPSConfig.js b/src/core/typedefs/FPSConfig.js
@@ -3,7 +3,7 @@
  * @since 3.0.0
  *
  * @property {integer} [min=5] - The minimum acceptable rendering rate, in frames per second.
- * @property {integer} [target=60] - The optimum rendering rate, in frames per second.
+ * @property {integer} [target=60] - The optimum rendering rate, in frames per second. This does not enforce the fps rate, it merely tells Phaser what rate is considered optimal for this game.
  * @property {boolean} [forceSetTimeOut=false] - Use setTimeout instead of requestAnimationFrame to run the game loop.
  * @property {integer} [deltaHistory=10] - Calculate the average frame delta from this many consecutive frame intervals.
  * @property {integer} [panicMax=120] - The amount of frames the time step counts before we trust the delta values again.

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`* @since 3.0.0`
`4`	`4`	`*`
`5`	`5`	`* @property {integer} [min=5] - The minimum acceptable rendering rate, in frames per second.`
`6`		`- * @property {integer} [target=60] - The optimum rendering rate, in frames per second.`
	`6`	`+ * @property {integer} [target=60] - The optimum rendering rate, in frames per second. This does not enforce the fps rate, it merely tells Phaser what rate is considered optimal for this game.`
`7`	`7`	`* @property {boolean} [forceSetTimeOut=false] - Use setTimeout instead of requestAnimationFrame to run the game loop.`
`8`	`8`	`* @property {integer} [deltaHistory=10] - Calculate the average frame delta from this many consecutive frame intervals.`
`9`	`9`	`* @property {integer} [panicMax=120] - The amount of frames the time step counts before we trust the delta values again.`