add a comment over the new infos structure

This commit is contained in:
Tamo 2022-11-15 17:56:07 +01:00
parent 9327db3e91
commit 9473cccc27
No known key found for this signature in database
GPG Key ID: 20CD8020AFA88D69

View File

@ -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)] #[derive(Debug, Clone, Serialize)]
struct Infos { struct Infos {
env: String, env: String,