Update doc

gyli · Jun 7, 2022 · 8ed06f8 · 8ed06f8
1 parent 3898a15
commit 8ed06f8
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -1,7 +1,7 @@
 Examples
 ========
 
-Several examples are shown below by topics, which would go through every parameter. Please check out `API Reference <class.html>`_ for the detail of parameter.
+Several examples are shown below by topics, which covers all parameters that PyWaffle has, and their most common use cases. If you are looking for the detailed definition and description of parameters, please check out `API Reference <class.html>`_.
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/examples/block_colors.md b/docs/examples/block_colors.md
@@ -1,6 +1,6 @@
 # Block Colors
 
-Parameter `colors` accepts colors in a list or tuple. Its length must be same to `values`.
+Parameter `colors` accepts colors in a list or tuple. The length must be same to `values`, and the acceptable color format includes case-insensitive hex RGB or RGBA, RGB or RGBA tuple, single character notation, case-insensitive X11/CSS4 color name, and more, as long as Matplotlib can recognize. See Matplotlib [Colors](https://matplotlib.org/stable/tutorials/colors/colors.html#specifying-colors) for the full list.
 
 ```python
 fig = plt.figure(

diff --git a/docs/font_awesome_integration.rst b/docs/font_awesome_integration.rst
@@ -16,4 +16,4 @@ If you would like to upgrade :code:`fontawesomefree` and use the newer version w
 By running the above commands, PyWaffle will generate a new icon mapping for the newer version :code:`fontawesomefree` under the package directory, and takes care of everything. You will be free to start using new icons!
 
 For how to use Font Awesome with PyWaffle, please see `Plot with Characters or Icons
-<https://pywaffle.readthedocs.io/en/latest/examples/plot_with_characters_or_icons.html#icons>`_.
+<examples/plot_with_characters_or_icons.html#icons>`_.