docstrings and changelog

nicolaskruchten · nicolaskruchten · commit d19078fe8baf · 2021-12-20T14:00:46.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,20 +5,20 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## UNRELEASED
 
-### Fixed
-  - Fixed ValueError when `ff.create_annotated_heatmap` passes `rgba()` colors into `to_rgb_color_list` [#3478](https://github.com/plotly/plotly.py/issues/3478)
-
 ### Added
 
   - `text_auto` argument to `px.bar`, `px.histogram`, `px.density_heatmap`, `px.imshow` [#3518](https://github.com/plotly/plotly.py/issues/3518)
   - Deprecated `ff.create_annotated_heatmap`, `ff.create_county_choropleth`, `ff.create_gantt` [#3518](https://github.com/plotly/plotly.py/issues/3518)
-  - `div_id` argument to `pio.to_html` to optionally make its IDs deterministic [#3487](https://github.com/plotly/plotly.py/issues/3487)
-  
+  - `div_id` argument to `pio.to_html`, `pio.write_html`, `fig.to_html` and `fig.write_html` to optionally make its IDs deterministic [#3487](https://github.com/plotly/plotly.py/issues/3487) with thanks to [@Skn0tt](https://github.com/Skn0tt)
+
 ### Updated
   - Updated Plotly.js to from version 2.6.3 to version 2.8.1. See the [plotly.js CHANGELOG](https://github.com/plotly/plotly.js/blob/master/CHANGELOG.md#280----2021-12-10) for more information. Notable changes include:
     - Horizontal color bars
-    - texttemplate for histogram-like traces
-    - text for heatmap-like traces
+    - `texttemplate` for histogram-like and heatmap-like traces
+
+### Fixed
+  - Fixed ValueError when `ff.create_annotated_heatmap` passes `rgba()` colors into `to_rgb_color_list` [#3478](https://github.com/plotly/plotly.py/issues/3478) with thanks to [@janosh](https://github.com/janosh)
+
 
 ## [5.4.0] - 2021-11-15
 
diff --git a/packages/python/plotly/plotly/basedatatypes.py b/packages/python/plotly/plotly/basedatatypes.py
@@ -3576,6 +3576,10 @@ def to_html(self, *args, **kwargs):
         validate: bool (default True)
             True if the figure should be validated before being converted to
             JSON, False otherwise.
+        div_id: str (default None)
+            If provided, this is the value of the id attribute of the div tag. If None, the
+            id attribute is a UUID.
+
         Returns
         -------
         str
@@ -3687,9 +3691,13 @@ def write_html(self, *args, **kwargs):
         validate: bool (default True)
             True if the figure should be validated before being converted to
             JSON, False otherwise.
-        auto_open: bool (default True
+        auto_open: bool (default True)
             If True, open the saved file in a web browser after saving.
             This argument only applies if `full_html` is True.
+        div_id: str (default None)
+            If provided, this is the value of the id attribute of the div tag. If None, the
+            id attribute is a UUID.
+
         Returns
         -------
         str
diff --git a/packages/python/plotly/plotly/io/_html.py b/packages/python/plotly/plotly/io/_html.py
@@ -125,6 +125,10 @@ def to_html(
     validate: bool (default True)
         True if the figure should be validated before being converted to
         JSON, False otherwise.
+    div_id: str (default None)
+        If provided, this is the value of the id attribute of the div tag. If None, the
+        id attribute is a UUID.
+
     Returns
     -------
     str
@@ -492,9 +496,13 @@ def write_html(
     validate: bool (default True)
         True if the figure should be validated before being converted to
         JSON, False otherwise.
-    auto_open: bool (default True
+    auto_open: bool (default True)
         If True, open the saved file in a web browser after saving.
         This argument only applies if `full_html` is True.
+    div_id: str (default None)
+        If provided, this is the value of the id attribute of the div tag. If None, the
+        id attribute is a UUID.
+
     Returns
     -------
     str
