changeset 1315:14dab195b2b4

layouts: update doc string to inform about using the right object
author Sean Farley <sean.michael.farley@gmail.com>
date Mon, 24 Mar 2014 11:20:56 -0500
parents 577054dbd9af
children 91eb0ad1376a
files hgsubversion/layouts/__init__.py
diffstat 1 files changed, 2 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/hgsubversion/layouts/__init__.py
+++ b/hgsubversion/layouts/__init__.py
@@ -34,7 +34,8 @@ NAME_TO_CLASS = {
 def layout_from_name(name, meta):
     """Returns a layout module given the layout name
 
-    You should use one of the layout.detect.* functions to get the
+    You should be able to read the layout name from meta.layout but, if
+    necessary, you can use one of the meta.layout_from_* functions to get the
     name to pass to this function.
 
     """