Add docstrings

iterative · Sep 30, 2022 · 677b725 · 677b725
1 parent d7545f8
commit 677b725
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/src/dvc_render/plotly.py b/src/dvc_render/plotly.py
@@ -6,6 +6,8 @@
 
 
 class PlotlyRenderer(Renderer):
+    """Renderer using plotly.js mimicking VegaRenderer"""
+
     TYPE = "plotly"
 
     DIV = """
@@ -23,10 +25,12 @@ class PlotlyRenderer(Renderer):
     <script src="https://cdn.plot.ly/plotly-latest.min.js"></script>
     """
 
+    # pylint: disable=W0231
     def __init__(self, datapoints: List, name: str, **properties):
         super().__init__(datapoints, name, **properties)
 
     def convert_datapoints(self, datapoints):
+        """Convert from dvc-render format to plotly json format"""
         traces = {}
         for datapoint in datapoints:
             revision = datapoint["rev"]

diff --git a/tests/test_plotly.py b/tests/test_plotly.py
@@ -4,6 +4,8 @@
 
 from dvc_render.plotly import PlotlyRenderer
 
+# pylint: disable=missing-function-docstring,
+
 
 def test_plotly_partial_html():
     props = {"x": "first_val", "y": "second_val", "template": "scatter"}