add LocalEnvironmentPanel doc strings

Author: janosh

crystal_toolkit/components/localenv.py

@@ -104,6 +104,8 @@ def _get_local_order_parameters(structure_graph, n):
 
 
 class LocalEnvironmentPanel(PanelComponent):
+    """A panel to analyze the local chemical environments in a crystal."""
+
     def __init__(self, *args, **kwargs) -> None:
         super().__init__(*args, **kwargs)
         self.create_store("graph")
@@ -114,17 +116,21 @@ def __init__(self, *args, **kwargs) -> None:
 
     @property
     def title(self) -> str:
+        """Title of the panel."""
         return "Local Environments"
 
     @property
     def description(self) -> str:
+        """Description of the panel."""
         return "Analyze the local chemical environments in your crystal."
 
     @property
     def loading_text(self):
+        """Text to display while loading."""
         return "Analyzing environments"
 
     def contents_layout(self) -> html.Div:
+        """HTML layout of the panel contents."""
         algorithm_choices = self.get_choice_input(
             label="Analysis method",
             kwarg_label="algorithm",
@@ -145,6 +151,7 @@ def contents_layout(self) -> html.Div:
 
     @staticmethod
     def get_graph_data(graph, display_options):
+        """Get the data for the graph visualization."""
         color_scheme = display_options.get("color_scheme", "Jmol")
 
         nodes = []
@@ -197,6 +204,7 @@ def get_graph_data(graph, display_options):
         return {"nodes": nodes, "edges": edges}
 
     def generate_callbacks(self, app, cache):
+        """Generate the callbacks for the panel interactions."""
         super().generate_callbacks(app, cache)
 
         @app.callback(

pyproject.toml

@@ -56,7 +56,7 @@ exclude = ["docs_rst"]
 
 [tool.setuptools_scm]
 write_to = "crystal_toolkit/_version.py"
-write_to_template = '__version__ = "{version}"\n'
+write_to_template = '__version__ = "{version}"'
 local_scheme = "no-local-version"
 
 [build-system]