Revert "removed experimental status from WebSocket and JSON Pointer s…

…upport" This reverts commit 292b6e7.
mojolicious · Jan 30, 2012 · 7e0ef2d · 7e0ef2d
1 parent 292b6e7
commit 7e0ef2d
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 21 deletions.
diff --git a/Changes b/Changes
@@ -1,11 +1,9 @@
 This file documents the revision history for Perl extension Mojolicious.
 
 2.47    2012-01-30 00:00:00
-        - Added drain event to Mojo::Content.
-        - Added drain event to Mojo::Transaction::WebSocket.
+        - Added EXPERIMENTAL drain event to Mojo::Content.
+        - Added EXPERIMENTAL drain event to Mojo::Transaction::WebSocket.
         - Added pdf MIME type. (bfaist)
-        - Removed experimental status from Mojo::Transaction::WebSocket.
-        - Removed experimental status from Mojo::JSON::Pointer.
         - Improved documentation.
         - Improved tests.
         - Fixed small bug in Mojo::IOLoop::Stream that caused close events to

diff --git a/lib/Mojo/Content.pm b/lib/Mojo/Content.pm
@@ -423,7 +423,8 @@ L<Mojo::Content> can emit the following events.
     ...
   });
 
-Emitted once all data has been written.
+Emitted once all data has been written. Note that this event is EXPERIMENTAL
+and might change without warning!
 
   $content->on(drain => sub {
     my $content = shift;

diff --git a/lib/Mojo/JSON/Pointer.pm b/lib/Mojo/JSON/Pointer.pm
@@ -51,7 +51,8 @@ Mojo::JSON::Pointer - JSON Pointers
 =head1 DESCRIPTION
 
 L<Mojo::JSON::Pointer> implements JSON Pointers as described in
-L<http://tools.ietf.org/html/draft-pbryan-zyp-json-pointer-02>.
+L<http://tools.ietf.org/html/draft-pbryan-zyp-json-pointer-02>. Note that
+this module is EXPERIMENTAL and might change without warning!
 
 =head1 METHODS
 

diff --git a/lib/Mojo/Message.pm b/lib/Mojo/Message.pm
@@ -777,7 +777,8 @@ Alias for L<Mojo::Content/"is_multipart">.
 
 Decode JSON message body directly using L<Mojo::JSON> if possible, returns
 C<undef> otherwise. An optional JSON Pointer can be used to extract a
-specific value with L<Mojo::JSON::Pointer>.
+specific value with L<Mojo::JSON::Pointer>. Note that the JSON Pointer
+argument of this method is EXPERIMENTAL and might change without warning!
 
   say $message->json->{foo}->{bar}->[23];
   say $message->json('/foo/bar/23');

diff --git a/lib/Mojo/Transaction/WebSocket.pm b/lib/Mojo/Transaction/WebSocket.pm
@@ -343,7 +343,8 @@ Mojo::Transaction::WebSocket - WebSocket transaction container
 =head1 DESCRIPTION
 
 L<Mojo::Transaction::WebSocket> is a container for WebSocket transactions as
-described in RFC 6455.
+described in RFC 6455. Note that this module is EXPERIMENTAL and might change
+without warning!
 
 =head1 EVENTS
 

diff --git a/lib/Mojo/UserAgent.pm b/lib/Mojo/UserAgent.pm
@@ -977,7 +977,8 @@ transactions non-blocking.
   $ua->websocket('ws://localhost:3000' => sub {...});
 
 Open a non-blocking WebSocket connection with transparent handshake, takes
-the exact same arguments as L<Mojo::UserAgent::Transactor/"websocket">.
+the exact same arguments as L<Mojo::UserAgent::Transactor/"websocket">. Note
+that this method is EXPERIMENTAL and might change without warning!
 
   $ua->websocket('ws://localhost:3000/echo' => sub {
     my ($ua, $tx) = @_;

diff --git a/lib/Mojolicious/Controller.pm b/lib/Mojolicious/Controller.pm
@@ -922,7 +922,8 @@ defaults to rendering an empty C<204> response.
   $c = $c->send_message('Hi there!', sub {...});
 
 Send a message non-blocking via WebSocket, the optional drain callback will
-be invoked once all data has been written.
+be invoked once all data has been written. Note that this method is
+EXPERIMENTAL and might change without warning!
 
   # Send JSON object as text frame
   $c->send_message([text => Mojo::JSON->new->encode({hello => 'world'})]);

diff --git a/lib/Mojolicious/Routes.pm b/lib/Mojolicious/Routes.pm
@@ -949,7 +949,8 @@ Add a waypoint to this route as nested child.
   my $websocket = $r->websocket('/:foo' => sub {...});
 
 Generate route matching only C<WebSocket> handshakes. See also the
-L<Mojolicious::Lite> tutorial for more argument variations.
+L<Mojolicious::Lite> tutorial for more argument variations. Note that this
+method is EXPERIMENTAL and might change without warning!
 
 =head1 SHORTCUTS
 

diff --git a/lib/Test/Mojo.pm b/lib/Test/Mojo.pm
@@ -537,7 +537,8 @@ Opposite of C<element_exists>.
   $t = $t->finish_ok;
   $t = $t->finish_ok('finished successfully');
 
-Finish C<WebSocket> connection.
+Finish C<WebSocket> connection. Note that this method is EXPERIMENTAL and
+might change without warning!
 
 =head2 C<get_ok>
 
@@ -594,50 +595,57 @@ Check response content for JSON data.
   $t = $t->json_is('/foo/bar/1' => 2, 'right value');
 
 Check the value extracted from JSON response using the given JSON Pointer
-with L<Mojo::JSON::Pointer>.
+with L<Mojo::JSON::Pointer>. Note that this method is EXPERIMENTAL and might
+change without warning!
 
 =head2 C<json_has>
 
   $t = $t->json_has('/foo');
   $t = $t->json_has('/minibar', 'has a minibar');
 
 Check if JSON response contains a value that can be identified using the
-given JSON Pointer with L<Mojo::JSON::Pointer>.
+given JSON Pointer with L<Mojo::JSON::Pointer>. Note that this method is
+EXPERIMENTAL and might change without warning!
 
 =head2 C<json_hasnt>
 
   $t = $t->json_hasnt('/foo');
   $t = $t->json_hasnt('/minibar', 'no minibar');
 
-Opposite of C<json_has>.
+Opposite of C<json_has>. Note that this method is EXPERIMENTAL and might
+change without warning!
 
 =head2 C<message_is>
 
   $t = $t->message_is('working!');
   $t = $t->message_is('working!', 'right message');
 
-Check WebSocket message for exact match.
+Check WebSocket message for exact match. Note that this method is
+EXPERIMENTAL and might change without warning!
 
 =head2 C<message_isnt>
 
   $t = $t->message_isnt('working!');
   $t = $t->message_isnt('working!', 'different message');
 
-Opposite of C<message_is>.
+Opposite of C<message_is>. Note that this method is EXPERIMENTAL and might
+change without warning!
 
 =head2 C<message_like>
 
   $t = $t->message_like(qr/working!/);
   $t = $t->message_like(qr/working!/, 'right message');
 
-Check WebSocket message for similar match.
+Check WebSocket message for similar match. Note that this method is
+EXPERIMENTAL and might change without warning!
 
 =head2 C<message_unlike>
 
   $t = $t->message_unlike(qr/working!/);
   $t = $t->message_unlike(qr/working!/, 'different message');
 
-Opposite of C<message_like>.
+Opposite of C<message_like>. Note that this method is EXPERIMENTAL and might
+change without warning!
 
 =head2 C<post_ok>
 
@@ -671,7 +679,8 @@ Reset user agent session.
   $t = $t->send_message_ok('hello');
   $t = $t->send_message_ok('hello', 'sent successfully');
 
-Send C<WebSocket> message.
+Send C<WebSocket> message. Note that this method is EXPERIMENTAL and might
+change without warning!
 
 =head2 C<status_is>
 
@@ -720,7 +729,8 @@ Opposite of C<text_like>.
   $t = $t->websocket_ok('/echo');
 
 Open a C<WebSocket> connection with transparent handshake, takes the exact
-same arguments as L<Mojo::UserAgent/"websocket">.
+same arguments as L<Mojo::UserAgent/"websocket">. Note that this method is
+EXPERIMENTAL and might change without warning!
 
 =head1 SEE ALSO