add get_breadcrumb() doc str

Author: janosh

crystal_toolkit/helpers/layouts.py

@@ -439,20 +439,24 @@ def __init__(self, *args, **kwargs) -> None:
 
 
 def get_breadcrumb(parts):
+    """Create a breadcrumb navigation bar.
+
+    Args:
+        parts (dict): Dictionary of name, link pairs.
+
+    Returns:
+        html.Nav: Breadcrumb navigation bar.
+    """
     if not parts:
-        return html.Div()
+        return html.Nav()
 
-    breadcrumbs = html.Nav(
-        html.Ul(
-            [
-                html.Li(
-                    dcc.Link(name, href=link),
-                    className=(None if idx != len(parts) - 1 else "is-active"),
-                )
-                for idx, (name, link) in enumerate(parts.items())
-            ]
-        ),
-        className="breadcrumb",
-    )
+    links = [
+        html.Li(
+            dcc.Link(name, href=link),
+            className="is-active" if idx == len(parts) - 1 else None,
+        )
+        for idx, (name, link) in enumerate(parts.items())
+    ]
+    breadcrumbs = html.Nav(html.Ul(links), className="breadcrumb")
 
     return breadcrumbs

crystal_toolkit/helpers/povray_renderer.py

@@ -135,8 +135,8 @@
 
 
 def pov_write_data(input_scene_comp, fstream):
-    """parse a primitive display object in crystaltoolkit and print it to POV-Ray input_scene_comp
-    fstream.
+    """Parse a primitive display object in crystaltoolkit and print it to POV-Ray
+    input_scene_comp fstream.
     """
     vect = "{:.4f},{:.4f},{:.4f}"
 

crystal_toolkit/renderables/volumetric.py

@@ -1,6 +1,9 @@
 from __future__ import annotations
 
+from typing import Any
+
 import numpy as np
+from numpy.typing import ArrayLike
 from pymatgen.io.vasp import VolumetricData
 
 from crystal_toolkit.core.scene import Scene, Surface
@@ -9,15 +12,22 @@
 
 
 def get_isosurface_scene(
-    self, data_key="total", isolvl=0.05, step_size=4, origin=None, **kwargs
-):
+    self,
+    data_key: str = "total",
+    isolvl: float = 0.05,
+    step_size: int = 4,
+    origin: ArrayLike = None,
+    **kwargs: Any,
+) -> Scene:
     """Get the isosurface from a VolumetricData object.
 
     Args:
         data_key (str, optional): Use the volumetric data from self.data[data_key]. Defaults to 'total'.
         isolvl (float, optional): The cutoff for the isosurface to using the same units as VESTA so
-        e/bohr and kept grid size independent
+            e/bohr and kept grid size independent
         step_size (int, optional): step_size parameter for marching_cubes_lewiner. Defaults to 3.
+        origin (ArrayLike, optional): The origin of the isosurface. Defaults to None.
+        **kwargs: Passed to the Surface object.
 
     Returns:
         Scene: object containing the isosurface component