added note about name variable (home-assistant#11970)

akasma74 · klaasnicolaas · web-flow · commit afd1e37956c5 · 2020-02-06T10:22:02.000+01:00
* added note about name variable

I though that name is just for frontend and spent some time finding out where my sensor had gone when I had changed its name.
Hope it will save others' time.
Actually, I don't think this component's approach is great - would be much more intuitive to have name as a key of a dictionary (as with template sensors, for example) and a friendly_name for UI.
Unfortunately, there are many of similar components - perhaps they are older than current template sensor's implementation?

* links -&gt; relative

* ✏️ Tweak

Co-authored-by: Klaas Schoute &lt;klaas_schoute@hotmail.com&gt;
diff --git a/source/_integrations/history_stats.markdown b/source/_integrations/history_stats.markdown
@@ -47,7 +47,7 @@ state:
   required: true
   type: string
 name:
-  description: Name displayed on the frontend.
+  description: Name displayed on the frontend. Note that it is used by Home Assistant to generate sensor's `object_id` so it is advisable to choose a unique one and change name for frontend using [customization](/docs/configuration/customizing-devices/#friendly_name) or via [Lovelace](/lovelace/entities/#name).
   required: false
   default: unnamed statistics
   type: string
