mention returned objects consistently

mojolicious · Jun 16, 2017 · 2c914f3 · 2c914f3
1 parent fb3caad
commit 2c914f3
Show file tree

Hide file tree

Showing 10 changed files with 16 additions and 12 deletions.
diff --git a/Changes b/Changes
@@ -1,5 +1,5 @@
 
-7.34  2017-06-13
+7.34  2017-06-16
 
 7.33  2017-06-05
   - Added EXPERIMENTAL support for :matches pseudo-class and :not pseudo-class

diff --git a/lib/Mojo/ByteStream.pm b/lib/Mojo/ByteStream.pm
@@ -137,7 +137,7 @@ Camelize bytestream with L<Mojo::Util/"camelize">.
 
   my $stream2 = $stream->clone;
 
-Clone bytestream.
+Return a new L<Mojo::ByteStream> object cloned from this bytestream.
 
 =head2 decamelize
 

diff --git a/lib/Mojo/Content.pm b/lib/Mojo/Content.pm
@@ -445,7 +445,8 @@ Extract charset from C<Content-Type> header.
 
   my $clone = $content->clone;
 
-Clone content if possible, otherwise return C<undef>.
+Return a new L<Mojo::Content> object cloned from this content if possible,
+otherwise return C<undef>.
 
 =head2 generate_body_chunk
 

diff --git a/lib/Mojo/Content/MultiPart.pm b/lib/Mojo/Content/MultiPart.pm
@@ -272,7 +272,8 @@ Generate a suitable boundary for content and add it to C<Content-Type> header.
 
   my $clone = $multi->clone;
 
-Clone content if possible, otherwise return C<undef>.
+Return a new L<Mojo::Content::MultiPart> object cloned form this content if
+possible, otherwise return C<undef>.
 
 =head2 get_body_chunk
 

diff --git a/lib/Mojo/Content/Single.pm b/lib/Mojo/Content/Single.pm
@@ -135,7 +135,8 @@ Content size in bytes.
 
   my $clone = $single->clone;
 
-Clone content if possible, otherwise return C<undef>.
+Return a new L<Mojo::Content::Single> object cloned from this content if
+possible, otherwise return C<undef>.
 
 =head2 get_body_chunk
 

diff --git a/lib/Mojo/Headers.pm b/lib/Mojo/Headers.pm
@@ -298,7 +298,7 @@ Get or replace current header value, shortcut for the C<Cache-Control> header.
 
   my $clone = $headers->clone;
 
-Clone headers.
+Return a new L<Mojo::Headers> object cloned from these headers.
 
 =head2 connection
 

diff --git a/lib/Mojo/Message/Request.pm b/lib/Mojo/Message/Request.pm
@@ -340,7 +340,8 @@ implements the following new ones.
 
   my $clone = $req->clone;
 
-Clone request if possible, otherwise return C<undef>.
+Return a new L<Mojo::Message::Request> object cloned from this request if
+possible, otherwise return C<undef>.
 
 =head2 cookies
 

diff --git a/lib/Mojo/Parameters.pm b/lib/Mojo/Parameters.pm
@@ -247,7 +247,7 @@ Append parameters. Note that this method will normalize the parameters.
 
   my $params2 = $params->clone;
 
-Clone parameters.
+Return a new L<Mojo::Parameters> object cloned from these parameters.
 
 =head2 every_param
 

diff --git a/lib/Mojo/Path.pm b/lib/Mojo/Path.pm
@@ -187,7 +187,7 @@ treated as C<.> to protect from path traversal attacks.
 
   my $clone = $path->clone;
 
-Clone path.
+Return a new L<Mojo::Path> object cloned from this path.
 
 =head2 contains
 

diff --git a/lib/Mojo/URL.pm b/lib/Mojo/URL.pm
@@ -294,7 +294,7 @@ following new ones.
 
   my $url2 = $url->clone;
 
-Clone this URL.
+Return a new L<Mojo::URL> object cloned from this URL.
 
 =head2 host_port
 
@@ -457,8 +457,8 @@ object.
   my $abs = $url->to_abs;
   my $abs = $url->to_abs(Mojo::URL->new('http://example.com/foo'));
 
-Clone relative URL and turn it into an absolute one using L</"base"> or
-provided base URL.
+Return a new L<Mojo::URL> object cloned from this relative URL and turn it into
+an absolute one using L</"base"> or provided base URL.
 
   # "http://example.com/foo/baz.xml?test=123"
   Mojo::URL->new('baz.xml?test=123')