From bd99d60736c673d5fb9e0d14e28467d9ad801c86 Mon Sep 17 00:00:00 2001
From: Julien Piccini <piccini.julien@gmail.com>
Date: Mon, 26 Apr 2021 13:34:59 +0200
Subject: [PATCH] adding release note and compareReportSuite explanatio

---
 docs/main.md     | 20 +++++++++++++++++++-
 docs/releases.md |  1 +
 2 files changed, 20 insertions(+), 1 deletion(-)

diff --git a/docs/main.md b/docs/main.md
index 9a53006..bcfb62e 100644
--- a/docs/main.md
+++ b/docs/main.md
@@ -589,4 +589,22 @@ Results for Calculated Metric:
 'metrics' : {"metrics/bouncerate","metrics/visits"},
 'rsid' : "rsid",
 }
-```
\ No newline at end of file
+```
+
+## Compare ReportSuite
+
+The `compareReportSuites` method allows you to compare the setup between reportSuites for either dimensions and metrics.\
+It also has several parameters that would allow for extensive comparison (with attribution) or just names.
+
+* compareReportSuites
+  Compare reportSuite on dimensions (default) or metrics based on the comparison selected.
+  Returns a dataframe with multi-index and a column telling which elements are differents
+  Arguments:
+  * listRsids : REQUIRED : list of report suite ID to compare
+  * element : REQUIRED : Elements to compare. 2 possible choices:
+    * dimensions (default)
+    * metrics
+  * comparison : REQUIRED : Type of comparison to do:
+    * full (default) : compare name and settings
+    * name : compare only names
+* save : OPTIONAL : if you want to save in a csv.
\ No newline at end of file
diff --git a/docs/releases.md b/docs/releases.md
index e79db0a..1fc68db 100644
--- a/docs/releases.md
+++ b/docs/releases.md
@@ -8,6 +8,7 @@ The changes have been tracked starting version 0.1.0
 * adding `compareReportSuites` method
 * adding `reportType` as attribute from projects. Either `desktop` or `mobile`
 * adding `version` and `curation` attributes by default on dict version of `project`.
+* adding `scanSegment` and `scanCalculatedMetric` methods.
 
 ## version 0.2.6