fix: typo

Author: KD-7

examples/plot_interest_radar.py

@@ -42,7 +42,7 @@
         "Dimension",
         "Computer virus",
     ],
-    visualize_variance=False,
+    visualise_variance=False,
 )
 
 # you can also use plotter.show() here

truelearn/tests/test_utils_visualisations.py

@@ -473,7 +473,7 @@ def test_top_n(self, resources):
 
     def test_no_variance(self, resources):
         plotter = visualisations.RadarPlotter()
-        plotter.plot(resources[0], visualize_variance=False)
+        plotter.plot(resources[0], visualise_variance=False)
         return plotter
 
 

truelearn/utils/visualisations/_bar_plotter.py

@@ -49,7 +49,7 @@ def plot(
         topics: Optional[Iterable[str]] = None,
         top_n: Optional[int] = None,
         history: bool = False,
-        visualize_variance: bool = True,
+        visualise_variance: bool = True,
     ) -> Self:
         """Plot the graph based on the given data.
 
@@ -70,7 +70,7 @@ def plot(
                 Whether to utilize history information in the visualisation.
                 If this is set to True, an attribute called history must be
                 present in all knowledge components.
-            visualize_variance:
+            visualise_variance:
                 Whether to visualise variance.
         """
         content_dict, _ = self._standardise_data(content, history, topics)
@@ -110,7 +110,7 @@ def plot(
                     "color": "black",
                     "thickness": 4,
                     "width": 3,
-                    "visible": visualize_variance,
+                    "visible": visualise_variance,
                 },
                 customdata=np.transpose(
                     [variances, number_of_videos, last_video_watched]  # type: ignore

truelearn/utils/visualisations/_dot_plotter.py

@@ -49,7 +49,7 @@ def plot(
         topics: Optional[Iterable[str]] = None,
         top_n: Optional[int] = None,
         history: bool = False,
-        visualize_variance: bool = True,
+        visualise_variance: bool = True,
     ) -> Self:
         """Plot the graph based on the given data.
 
@@ -70,7 +70,7 @@ def plot(
                 Whether to utilize history information in the visualisation.
                 If this is set to True, an attribute called history must be
                 present in all knowledge components.
-            visualize_variance:
+            visualise_variance:
                 Whether to visualise variance.
         """
         content_dict, _ = self._standardise_data(content, history, topics)
@@ -110,7 +110,7 @@ def plot(
                     "color": "black",
                     "thickness": 4,
                     "width": 3,
-                    "visible": visualize_variance,
+                    "visible": visualise_variance,
                 },
                 customdata=np.transpose(
                     [variances, number_of_videos, last_video_watched]  # type: ignore

truelearn/utils/visualisations/_line_plotter.py

@@ -82,7 +82,7 @@ def plot(
         content: Union[List[Knowledge], Knowledge],
         topics: Optional[Iterable[str]] = None,
         top_n: Optional[int] = None,
-        visualize_variance: bool = False,
+        visualise_variance: bool = False,
     ) -> Self:
         """Plot the graph based on the given data.
 
@@ -100,7 +100,7 @@ def plot(
             top_n:
                 The number of topics to visualise. E.g. if top_n is 5, then the
                 top 5 topics ranked by mean will be visualised.
-            visualize_variance:
+            visualise_variance:
                 Whether to visualise variance.
         """
         if isinstance(content, list):
@@ -111,7 +111,7 @@ def plot(
         if not content_dict:
             return self
 
-        traces = [self._trace(tr_data, visualize_variance) for tr_data in content_dict]
+        traces = [self._trace(tr_data, visualise_variance) for tr_data in content_dict]
 
         self.figure.add_traces(traces)
 

truelearn/utils/visualisations/_radar_plotter.py

@@ -33,7 +33,7 @@ def plot(
         content: Knowledge,
         topics: Optional[Iterable[str]] = None,
         top_n: Optional[int] = None,
-        visualize_variance: bool = True,
+        visualise_variance: bool = True,
     ) -> Self:
         """Plot the graph based on the given data.
 
@@ -50,7 +50,7 @@ def plot(
             top_n:
                 The number of topics to visualise. E.g. if top_n is 5, then the
                 top 5 topics ranked by mean will be visualised.
-            visualize_variance:
+            visualise_variance:
                 Whether to visualise variance.
         """
         content_dict, _ = self._standardise_data(content, False, topics)
@@ -72,7 +72,7 @@ def plot(
             self._trace(means, titles, "Means"),
         )
 
-        if visualize_variance:
+        if visualise_variance:
             self.figure.add_trace(self._trace(variances, titles, "Variances"))
 
         self.figure.update_layout(