re #29 updated inline docs

lowks · Jan 29, 2015 · c804c22 · c804c22
1 parent 1964487
commit c804c22
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/lib/Radpath/directory.ex b/lib/Radpath/directory.ex
@@ -11,14 +11,15 @@ defmodule Radpath.Dirs do
 
   ## Arguments
 
-  - `path` path to show list of directories in bitstring 
+  - `path` path to show list of directories in bitstring.
+  - `regex_dir` String regex of directory pattern to show in final output.
   
   ## Usage
 
 
-      iex(4)> Radpath.dirs("/home/lowks/src/elixir/radpath/lib")
+      iex(4)> Radpath.dirs("/home/lowks/src/elixir/radpath/lib", regex_dir)
 
-      iex(3)> Radpath.dirs(["/home/lowks/src/elixir/radpath/lib", "/home/lowks/src/elixir/radpath/_build"])
+      iex(3)> Radpath.dirs(["/home/lowks/src/elixir/radpath/lib", "/home/lowks/src/elixir/radpath/_build"], regex_dir)
       
   """