better descriptions for some transaction methods

mojolicious · Nov 30, 2012 · e3f318f · e3f318f
1 parent 950424f
commit e3f318f
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 18 deletions.
diff --git a/Changes b/Changes
@@ -1,5 +1,5 @@
 
-3.64  2012-11-29
+3.64  2012-11-30
   - Improved documentation.
   - Fixed bug where Mojo::UserAgent::Transactor would escape
     Content-Disposition values.

diff --git a/lib/Mojo/Transaction.pm b/lib/Mojo/Transaction.pm
@@ -198,19 +198,21 @@ implements the following new ones.
 
   $tx->client_close;
 
-Transaction closed client-side.
+Transaction closed client-side, used to implement user agents.
 
 =head2 C<client_read>
 
   $tx->client_read($chunk);
 
-Read data client-side. Meant to be overloaded in a subclass.
+Read data client-side, used to implement user agents. Meant to be overloaded
+in a subclass.
 
 =head2 C<client_write>
 
   my $chunk = $tx->client_write;
 
-Write data client-side. Meant to be overloaded in a subclass.
+Write data client-side, used to implement user agents. Meant to be overloaded
+in a subclass.
 
 =head2 C<connection>
 
@@ -261,19 +263,21 @@ Remote interface address.
 
   $tx->server_close;
 
-Transaction closed server-side.
+Transaction closed server-side, used to implement web servers.
 
 =head2 C<server_read>
 
   $tx->server_read($chunk);
 
-Read data server-side. Meant to be overloaded in a subclass.
+Read data server-side, used to implement web servers. Meant to be overloaded
+in a subclass.
 
 =head2 C<server_write>
 
   my $chunk = $tx->server_write;
 
-Write data server-side. Meant to be overloaded in a subclass.
+Write data server-side, used to implement web servers. Meant to be overloaded
+in a subclass.
 
 =head2 C<success>
 

diff --git a/lib/Mojo/Transaction/HTTP.pm b/lib/Mojo/Transaction/HTTP.pm
@@ -251,13 +251,13 @@ implements the following new ones.
 
   $tx->client_read($chunk);
 
-Read data client-side.
+Read data client-side, used to implement user agents.
 
 =head2 C<client_write>
 
   my $chunk = $tx->client_write;
 
-Write data client-side.
+Write data client-side, used to implement user agents.
 
 =head2 C<keep_alive>
 
@@ -269,13 +269,13 @@ Check if connection can be kept alive.
 
   $tx->server_read($chunk);
 
-Read data server-side.
+Read data server-side, used to implement web servers.
 
 =head2 C<server_write>
 
   my $chunk = $tx->server_write;
 
-Write data server-side.
+Write data server-side, used to implement web servers.
 
 =head1 SEE ALSO
 

diff --git a/lib/Mojo/Transaction/WebSocket.pm b/lib/Mojo/Transaction/WebSocket.pm
@@ -433,25 +433,26 @@ Build WebSocket frame.
 
   my $success = $ws->client_challenge;
 
-Check WebSocket handshake challenge client-side.
+Check WebSocket handshake challenge client-side, used to implement user
+agents.
 
 =head2 C<client_handshake>
 
   $ws->client_handshake;
 
-Perform WebSocket handshake client-side.
+Perform WebSocket handshake client-side, used to implement user agents.
 
 =head2 C<client_read>
 
   $ws->client_read($data);
 
-Read data client-side.
+Read data client-side, used to implement user agents.
 
 =head2 C<client_write>
 
   my $chunk = $ws->client_write;
 
-Write data client-side.
+Write data client-side, used to implement user agents.
 
 =head2 C<connection>
 
@@ -552,19 +553,19 @@ will be invoked once all data has been written.
 
   $ws->server_handshake;
 
-Perform WebSocket handshake server-side.
+Perform WebSocket handshake server-side, used to implement web servers.
 
 =head2 C<server_read>
 
   $ws->server_read($data);
 
-Read data server-side.
+Read data server-side, used to implement web servers.
 
 =head2 C<server_write>
 
   my $chunk = $ws->server_write;
 
-Write data server-side.
+Write data server-side, used to implement web servers.
 
 =head1 DEBUGGING