From: Kieren Diment <kd@fenchurch.local>
Date: Mon, 22 Feb 2010 04:43:05 +0000 (+1100)
Subject: add documentation to clarify usage of this component.
X-Git-Tag: 0.09~5^2
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-View-Component-SubInclude.git;a=commitdiff_plain;h=6bd0988d8e1edd222ead8c640aaab7008505ecda

add documentation to clarify usage of this component.
---

diff --git a/lib/Catalyst/View/Component/SubInclude.pm b/lib/Catalyst/View/Component/SubInclude.pm
index 4bb7f69..a2b08a6 100644
--- a/lib/Catalyst/View/Component/SubInclude.pm
+++ b/lib/Catalyst/View/Component/SubInclude.pm
@@ -47,10 +47,13 @@ L<Moose::Role|Moose::Role>, so using L<Moose|Moose> in your view is required.
 Simply put, it's a way to include the output of a Catalyst sub-request somewhere
 in your page.
 
-It's built in an extensible way so that you're free to use sub-requests, Varnish
-ESI (L<http://www.catalystframework.org/calendar/2008/17>) or any other
+It's built in an extensible way so that you're free to use sub-requests,
+Varnish ESI (L<http://www.catalystframework.org/calendar/2008/17>) or any other
 sub-include plugin you might want to implement. An LWP plugin seems useful and
-might be developed in the future.
+might be developed in the future. If you need to address a resource by it's
+public path (i.e. the path part trailing C<http://example.com/myapp> then you
+will need to use L<Catalyst::Plugin::SubRequest> directly, and not this
+component.
 
 =head1 STASH FUNCTIONS