daveoncode
diff --git a/‎docs/_build/doctrees/environment.pickle
177 Bytes b/‎docs/_build/doctrees/environment.pickle
177 Bytes
diff --git a/‎docs/_build/doctrees/index.doctree
7.56 KB b/‎docs/_build/doctrees/index.doctree
7.56 KB
diff --git a/‎docs/_build/html/genindex.html
Lines changed: 10 additions & 0 deletions b/‎docs/_build/html/genindex.html
Lines changed: 10 additions & 0 deletions
diff --git a/‎docs/_build/html/index.html
Lines changed: 44 additions & 0 deletions b/‎docs/_build/html/index.html
Lines changed: 44 additions & 0 deletions
diff --git a/‎docs/_build/html/objects.inv
16 Bytes b/‎docs/_build/html/objects.inv
16 Bytes
diff --git a/‎docs/_build/html/searchindex.js
Lines changed: 1 addition & 1 deletion b/‎docs/_build/html/searchindex.js
Lines changed: 1 addition & 1 deletion
diff --git a/‎string_utils.py
Lines changed: 7 additions & 3 deletions b/‎string_utils.py
Lines changed: 7 additions & 3 deletions
@@ -125,6 +125,12 @@ <h2 id="C">C</h2>
   <dt><a href="index.html#string_utils.camel_case_to_snake">camel_case_to_snake() (in module string_utils)</a>
   </dt>
 
+  </dl></td>
+  <td style="width: 33%" valign="top"><dl>
+      
+  <dt><a href="index.html#string_utils.contains_html">contains_html() (in module string_utils)</a>
+  </dt>
+
   </dl></td>
 </tr></table>
 
@@ -199,6 +205,10 @@ <h2 id="S">S</h2>
   <dt><a href="index.html#module-string_utils">string_utils (module)</a>
   </dt>
 
+      
+  <dt><a href="index.html#string_utils.strip_html">strip_html() (in module string_utils)</a>
+  </dt>
+
   </dl></td>
 </tr></table>
 
 
@@ -351,6 +351,26 @@ <h1>Welcome to Python String Utils&#8217;s documentation!<a class="headerlink" h
 </table>
 </dd></dl>
 
+<dl class="function">
+<dt id="string_utils.contains_html">
+<code class="descclassname">string_utils.</code><code class="descname">contains_html</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#string_utils.contains_html" title="Permalink to this definition">¶</a></dt>
+<dd><p>Checks if the given string contains html code.
+By design, this function is very permissive regarding what to consider html code, don&#8217;t expect to use it
+as an html validator, its goal is to detect &#8220;malicious&#8221; or undesired html tags in the text.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>string</strong> (<em>str</em>) &#8211; Text to check</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if string contains html, false otherwise.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
 <dl class="function">
 <dt id="string_utils.camel_case_to_snake">
 <code class="descclassname">string_utils.</code><code class="descname">camel_case_to_snake</code><span class="sig-paren">(</span><em>string</em>, <em>separator='_'</em><span class="sig-paren">)</span><a class="headerlink" href="#string_utils.camel_case_to_snake" title="Permalink to this definition">¶</a></dt>
@@ -454,6 +474,30 @@ <h1>Welcome to Python String Utils&#8217;s documentation!<a class="headerlink" h
 </table>
 </dd></dl>
 
+<dl class="function">
+<dt id="string_utils.strip_html">
+<code class="descclassname">string_utils.</code><code class="descname">strip_html</code><span class="sig-paren">(</span><em>string</em>, <em>keep_tag_content=False</em><span class="sig-paren">)</span><a class="headerlink" href="#string_utils.strip_html" title="Permalink to this definition">¶</a></dt>
+<dd><p>Remove html code contained into the given string.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>string</strong> (<em>str</em>) &#8211; String to manipulate.</li>
+<li><strong>keep_tag_content</strong> (<em>bool</em>) &#8211; True to preserve tag content, False to remove tag and its content too (default).</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">String with html removed.</p>
+</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">str</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
 </div>
 <div class="section" id="indices-and-tables">
 <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
 
@@ -388,10 +388,14 @@ def shuffle(string):
 
 def strip_html(string, keep_tag_content=False):
     """
+    Remove html code contained into the given string.
 
-    :param string:
-    :param keep_tag_content:
-    :return:
+    :param string: String to manipulate.
+    :type string: str
+    :param keep_tag_content: True to preserve tag content, False to remove tag and its content too (default).
+    :type keep_tag_content: bool
+    :return: String with html removed.
+    :rtype: str
     """
     r = HTML_TAG_ONLY_RE if keep_tag_content else HTML_RE
     return r.sub('', string)