[Jifty-commit] r7408 - jifty/trunk/lib/Jifty/Manual

[Jifty commits]

Author: sartak
Date: Tue Aug 18 19:11:15 2009
New Revision: 7408

Modified:
   jifty/trunk/lib/Jifty/Manual/Preload.pod

Log:
Minor details

Modified: jifty/trunk/lib/Jifty/Manual/Preload.pod
==============================================================================
--- jifty/trunk/lib/Jifty/Manual/Preload.pod	(original)
+++ jifty/trunk/lib/Jifty/Manual/Preload.pod	Tue Aug 18 19:11:15 2009
@@ -29,12 +29,12 @@
 out to be a fairly simple way to figure out what to display next for
 preloading.
 
-Preloading should also be agnostic of real-world-time. If you preload a region
+Preloading should also be agnostic of real-world time. If you preload a region
 that contains a timestamp, then that timestamp may be stale by the time the
-region is actually shown. Similarly for duration. At the end of Hiveminder's
-task review, we tell you exactly how long you spent in the review. This final
-report update cannot be preloaded because the user may spend ten minutes on the
-last task.
+region is actually shown. Similarly for displaying duration. For example, at
+the end of Hiveminder's task review, we tell you exactly how long you spent in
+the review. This final report update cannot be preloaded because the user may
+spend ten minutes on the last task.
 
 Preloading can cause additional server load. Instead of a single request
 containing action submission and region updates, preloading sends a request
@@ -44,7 +44,8 @@
 
 Finally, preloading is pretty new. It has not been battle tested. There may be
 serious race conditions that result in inconsistencies that confound your
-users. There may be data loss. These things would be very difficult to debug.
+users. There may be data loss. It may interact strangely with other Jifty
+features. These things would be very difficult to debug.
 
 Good luck!
 
@@ -70,7 +71,7 @@
 region without having to send an AJAX request and wait for the response.
 
 The value of C<preload> is a cache key. This lets you reuse the same cache for
-multiple handlers. For example, if you're going to display ten vote buttons,
+preloaded regions. For example, if you're going to display ten vote buttons,
 then ordinarily you would make ten preload requests. However, if you give all
 of the buttons the C<vote> cache key, only one preload request will be made.
 Obviously this means that the specific button being clicked should not matter.
@@ -78,6 +79,9 @@
 to preload that with the same cache key as regular votes. In fact, you probably
 do not want to preload it all if it's a rare occurrence.
 
+Note that the C<$vote> action is submitted well after the next region has been
+preloaded!
+
 =head1 GORY DETAILS
 
 =cut