Changeset 11101

Timestamp:

03/13/10 06:39:55 (2 years ago)

Author:

adamk

Message:

Piddling tweaks (mostly docs)

File:

• trunk/Padre/lib/Padre/Task.pm (modified) (5 diffs)

trunk/Padre/lib/Padre/Task.pm

@@ -67 +67 @@
 since these must not be accessed from worker threads.
 
+However, you should be cautious when keeping references to GUI
+elements in your tasks, in case the GUI wants to destroy them
+before your task returns.
+
+Instead, it is better if your C<finish> method knows how to
+relocate the GUI element from scratch (and can safely handle
+the situation when the GUI element is gone, or has changed enough
+to make the task response irrelevent).
+
 =head1 DESCRIPTION
 
-This is the base class of all background operations in Padre. The SYNOPSIS
-explains the basic usage, but in a nutshell, you create a subclass, implement
-your own custom C<run> method, create a new instance, and call C<schedule>
-on it to run it in a worker thread. When the scheduler has a free worker
-thread for your task, the following steps happen:
+This is the base class of all background operations in Padre.
+The SYNOPSIS explains the basic usage, but in a nutshell, you create a
+subclass, implement your own custom C<run> method, create a new instance,
+and call C<schedule> on it to run it in a worker thread. When the scheduler
+has a free worker thread for your task, the following steps happen:
 
 =over 2
@@ -120 +129 @@
 our $STDERR_EVENT : shared;
 
-# TO DO: Why are there require?
+# TO DO: Why are these require?
 require Padre;
 require Padre::Wx;
@@ -142 +151 @@
 
 =cut
-
 
 sub new {
@@ -227 +235 @@
 
 sub prepare {
-    my $self = shift;
     return 1;
 }
@@ -249 +256 @@
 
 sub finish {
-    my $self = shift;
     return 1;
 }