Update docs

thombashi · May 29, 2016 · c206a67 · c206a67
1 parent 9545212
commit c206a67
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 3 deletions.
diff --git a/docs/pages/examples/sanitize.rst b/docs/pages/examples/sanitize.rst
@@ -1,7 +1,7 @@
 Sanitize a filename
 ----------------------------
 
-The :py:func:`.sanitize_filename()` function replace invalid character(s) 
+The :py:func:`.sanitize_filename()` function is replaced invalid character(s) 
 for a filename within the argument.
 
 .. include:: sanitize_filename_code.txt
@@ -10,7 +10,7 @@ for a filename within the argument.
 Sanitize a file path
 ----------------------------
 
-The :py:func:`.sanitize_file_path()` function replace invalid character(s) 
+The :py:func:`.sanitize_file_path()` function is replaced invalid character(s) 
 for a file path within the argument.
 
 .. include:: sanitize_file_path_code.txt
@@ -19,7 +19,15 @@ for a file path within the argument.
 Sanitize a variable name
 ----------------------------
 
-The :py:func:`.sanitize_python_var_name()` function replace invalid character(s) 
+The :py:func:`.sanitize_python_var_name()` function is replaced invalid character(s) 
 for a python variable within the argument.
 
 .. include:: sanitize_var_name_code.txt
+
+
+Replace symbols
+----------------------------
+
+The :py:func:`.replace_symbol()` function is replaced symbol(s) within the argument.
+
+.. include:: sanitize_replace_symbol_code.txt
diff --git a/docs/pages/examples/sanitize_replace_symbol_code.txt b/docs/pages/examples/sanitize_replace_symbol_code.txt
@@ -0,0 +1,11 @@
+.. code-block:: python
+    :caption: Sample code
+
+    import pathvalidate
+
+    print(pathvalidate.replace_symbol("_a*b:c<d>e%f/(g)h+i_0.txt"))
+
+.. code-block:: none
+    :caption: Output
+
+    abcdefghi0txt