Revision: b04addbd085c
Branch:   default
Author:   Pekka Klärck
Date:     Thu Apr 17 14:10:01 2014 UTC
Log:      XML: Added a note that string sources are not modified.

Update issue 1690
Summary: XML library: Document that sources given as strings are not modified in place
Status: Done
Owner: pekka.klarck
Labels: Priority-Low
The same text about modifying the source was in all keywords that
modify XML. Added a note that strings themselves are not modified to
`Get Element` keyword that those keywords use internally and link from
their docs.
http://code.google.com/p/robotframework/source/detail?r=b04addbd085c

Modified:
 /src/robot/libraries/XML.py

=======================================
--- /src/robot/libraries/XML.py Thu Jan 23 14:00:53 2014 UTC
+++ /src/robot/libraries/XML.py Thu Apr 17 14:10:01 2014 UTC
@@ -425,6 +425,12 @@
         `Parse XML` is recommended for parsing XML when the whole structure
         is needed. It must be used if there is a need to configure how XML
         namespaces are handled.
+
+ Many other keywords use this keyword internally, and keywords modifying
+        XML are typically documented to both to modify the given source and
+        to return it. Modifying the source does not apply if the source is
+        given as a string. The XML structure parsed based on the string and
+        then modified is nevertheless returned.
         """
         elements = self.get_elements(source, xpath)
         if len(elements) != 1:

--

--- You received this message because you are subscribed to the Google Groups "robotframework-commit" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to robotframework-commit+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to