Merge lp:~martinmassera/beautifulsoup/modifying-string-docs into lp:beautifulsoup

[martin massera]

Extending documentation for the "Modifying .string" section for the case of using a string with HTML content. Describes two ways: escaping the content and parsing the content.

Unmerged revisions

523. By martin massera on 2019-08-22

Adding documentation for parsing HTML content in the "Modifying .string" section

=== modified file 'doc/source/index.rst'
--- doc/source/index.rst	2019-07-21 19:50:49 +0000
+++ doc/source/index.rst	2019-08-22 17:41:47 +0000
@@ -1873,7 +1873,22 @@
   # <a href="http://example.com/">New link text.</a>
 
 Be careful: if the tag contained other tags, they and all their
-contents will be destroyed.
+contents will be destroyed. If the new string contains HTML content,
+it will be escaped and added as the tag's text::
+
+  html_string = "A <strong>BOLD</strong> statement"
+
+  tag.string = html_string
+  tag
+  # <a href="http://example.com/">A &lt;strong&gt;BOLD&lt;/strong&gt; statement</a>
+
+You can parse the HTML string by creting a
+``BeautifulSoap`` object and appending it as tags::
+
+  tag.clear()
+  tag.append(BeautifulSoup(html_string, 'html.parser'))
+  tag
+  # <a href="http://example.com/">A <strong>BOLD</strong> statement</a>
 
 ``append()``
 ------------