Updated desciption of function parse_wrmap.
authorphilipp <philipp@7aebc617-e5e2-0310-91dc-80fb5f6d2477>
Wed, 11 Sep 2013 20:18:06 +0000 (20:18 +0000)
committerphilipp <philipp@7aebc617-e5e2-0310-91dc-80fb5f6d2477>
Wed, 11 Sep 2013 20:18:06 +0000 (20:18 +0000)
git-svn-id: http://www.winterrodeln.org/svn/wrpylib/trunk@1563 7aebc617-e5e2-0310-91dc-80fb5f6d2477

wrpylib/wrmwmarkup.py

index b65670edcb375e6f31cbba27da38a2510ec7e630..7c63e27de790ecc4815a877807abd24a9f8f85ba 100644 (file)
@@ -385,11 +385,13 @@ def parse_wrmap_coordinates(coords):
 
 
 def parse_wrmap(wikitext):
-    """Parses the (unicode) u'<wrmap ...>content</wrmap>' of the Winterrodeln wrmap extension
-    out of a page. If wikitext does not contain the wrmap extension text None is returned.
-    If the wrmap contains invalid formatted lines, a ParseError is raised.
+    """Parses the (unicode) u'<wrmap ...>content</wrmap>' of the Winterrodeln wrmap extension.
+    If wikitext does not contain the <wrmap> tax or if the <wrmap> tag contains 
+    invalid formatted lines, a ParseError is raised.
+    Use wrpylib.mwmarkup.find_tag(wikitext, 'wrmap') to find the wrmap tag within an arbitrary
+    wikitext before using this function.
 
-    :param wikitext: wikitext containing the template. Example:
+    :param wikitext: wikitext containing only the template. Example:
 
     wikitext = u'''
     <wrmap lat="47.2417134" lon="11.21408895" zoom="14" width="700" height="400">