daveoncode
diff --git a/‎docs/_build/doctrees/environment.pickle
113 Bytes b/‎docs/_build/doctrees/environment.pickle
113 Bytes
diff --git a/‎docs/_build/doctrees/index.doctree
4.4 KB b/‎docs/_build/doctrees/index.doctree
4.4 KB
diff --git a/‎docs/_build/html/genindex.html
Lines changed: 11 additions & 0 deletions b/‎docs/_build/html/genindex.html
Lines changed: 11 additions & 0 deletions
diff --git a/‎docs/_build/html/index.html
Lines changed: 22 additions & 0 deletions b/‎docs/_build/html/index.html
Lines changed: 22 additions & 0 deletions
diff --git a/‎docs/_build/html/objects.inv
5 Bytes b/‎docs/_build/html/objects.inv
5 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: 13 additions & 0 deletions b/‎string_utils.py
Lines changed: 13 additions & 0 deletions
@@ -115,6 +115,7 @@ <h1 id="index">Index</h1>
  | <a href="#R"><strong>R</strong></a>
  | <a href="#S"><strong>S</strong></a>
  | <a href="#U"><strong>U</strong></a>
+ | <a href="#W"><strong>W</strong></a>
 
 </div>
 <h2 id="C">C</h2>
@@ -208,6 +209,16 @@ <h2 id="U">U</h2>
   <dt><a href="index.html#string_utils.uuid">uuid() (in module string_utils)</a>
   </dt>
 
+  </dl></td>
+</tr></table>
+
+<h2 id="W">W</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%" valign="top"><dl>
+      
+  <dt><a href="index.html#string_utils.words_count">words_count() (in module string_utils)</a>
+  </dt>
+
   </dl></td>
 </tr></table>
 
 
@@ -329,6 +329,28 @@ <h1>Welcome to Python String Utils&#8217;s documentation!<a class="headerlink" h
 </table>
 </dd></dl>
 
+<dl class="function">
+<dt id="string_utils.words_count">
+<code class="descclassname">string_utils.</code><code class="descname">words_count</code><span class="sig-paren">(</span><em>string</em><span class="sig-paren">)</span><a class="headerlink" href="#string_utils.words_count" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns the number of words contained into the given string.</p>
+<p>This method is smart, it does consider only sequence of one or more letter and/or numbers
+as &#8220;words&#8221;, so a string like this: &#8221;! &#64; # % ... []&#8221; will return zero!
+Moreover it is aware of punctuation, so the count for a string like &#8220;one,two,three.stop&#8221;
+will be 4 not 1 (even if there are no spaces in the 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"><strong>string</strong> (<em>str</em>) &#8211; String to check.</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Number of words.</td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">int</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>
 
@@ -259,6 +259,19 @@ def is_ip(string):
 
 
 def words_count(string):
+    """
+    Returns the number of words contained into the given string.
+
+    This method is smart, it does consider only sequence of one or more letter and/or numbers
+    as "words", so a string like this: "! @ # % ... []" will return zero!
+    Moreover it is aware of punctuation, so the count for a string like "one,two,three.stop"
+    will be 4 not 1 (even if there are no spaces in the string).
+
+    :param string: String to check.
+    :type string: str
+    :return: Number of words.
+    :rtype: int
+    """
     return len(WORDS_COUNT_RE.findall(string))