documentation

xadupre · Jul 25, 2018 · 0027c78 · 0027c78
1 parent e4e7fe5
commit 0027c78
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -29,7 +29,8 @@ Method ``Join``, ``GroupBy``, ``Sort`` with at most three columns.
 This limitations can easily be moved but cannot be infinite.
 Whenever possible, the methods return a view on the original DataFrame,
 a view is subset of rows and columns. The view is not necessarily smaller
-than the original data.
+than the original data. Below, some very simple examples, next
+[examples](README.rst) more complete examples.
 
 ### Example 1: inner API
 

diff --git a/examples/README.rst b/examples/README.rst
@@ -9,9 +9,14 @@ Tutorial to Scikit.ML.DataFrame
 DataFrame + GroupBy + Svg Plot
 ++++++++++++++++++++++++++++++
 
+This example shows how to do a simple
+groupby operation and to create a graph
+based on the grouped data.
+
 * `sln <DataFrameExample.sln>`_
 * `source <GroupBy_Plot/Program.cs>`_
 
 Output:
 
 .. image:: simple_graph.png
+    :width: 300