From 9473cccc27137f41ee89bc42b08a32b381d3159e Mon Sep 17 00:00:00 2001
From: Tamo <tamo@meilisearch.com>
Date: Tue, 15 Nov 2022 17:56:07 +0100
Subject: [PATCH] add a comment over the new infos structure

---
 meilisearch-http/src/analytics/segment_analytics.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/meilisearch-http/src/analytics/segment_analytics.rs b/meilisearch-http/src/analytics/segment_analytics.rs
index c7355fbcf..a0d272552 100644
--- a/meilisearch-http/src/analytics/segment_analytics.rs
+++ b/meilisearch-http/src/analytics/segment_analytics.rs
@@ -184,6 +184,11 @@ impl super::Analytics for SegmentAnalytics {
     }
 }
 
+/// This structure represent the `infos` field we send in the analytics.
+/// It's quite close to the `Opt` structure except all sensitive informations
+/// have been simplified to a boolean.
+/// It's send as-is in amplitude thus you should never update a name of the
+/// struct without the approval of the PM.
 #[derive(Debug, Clone, Serialize)]
 struct Infos {
     env: String,