fix: handle line continuations gracefully (#68)

* handle line continuations gracefully

* Update headings.md

* Update headings.md

Author: watermarkhu

docs/debug.py

@@ -1,8 +1,8 @@
+import os
 from contextlib import contextmanager
-from mkdocs.commands import serve
 from pathlib import Path
 
-import os
+from mkdocs.commands import serve
 
 
 @contextmanager

docs/usage/configuration/headings.md

@@ -521,11 +521,13 @@ plugins:
 Show the symbol type in headings.
 
 This option will prefix headings with
-<code class="doc-symbol doc-symbol-attribute"></code>,
+<code class="doc-symbol doc-symbol-property"></code>,
 <code class="doc-symbol doc-symbol-function"></code>,
 <code class="doc-symbol doc-symbol-method"></code>,
-<code class="doc-symbol doc-symbol-class"></code> or
-<code class="doc-symbol doc-symbol-module"></code> types.
+<code class="doc-symbol doc-symbol-class"></code>,
+<code class="doc-symbol doc-symbol-script"></code>,
+<code class="doc-symbol doc-symbol-namespace"></code> or.
+<code class="doc-symbol doc-symbol-folder"></code> types.
 See also [`show_symbol_type_toc`][show_symbol_type_toc].
 
 ```yaml title="in mkdocs.yml (global configuration)"

scripts/copy_and_update_python_templates.py

@@ -1,9 +1,10 @@
 """A script to copy the modules and attributes templates from
 the python handler to the matlab handler and update the names"""
 
-from mkdocstrings_handlers.python.handler import PythonHandler
-from pathlib import Path
 import re
+from pathlib import Path
+
+from mkdocstrings_handlers.python.handler import PythonHandler
 
 # Get the templates directory of the python handler
 pythonHandler = PythonHandler("python", "material")

src/mkdocstrings_handlers/matlab/__init__.py

@@ -1,9 +1,10 @@
 """MATLAB handler for mkdocstrings."""
 
-from mkdocstrings_handlers.matlab.handler import get_handler
-from mkdocstrings_handlers.matlab import collect, handler, models, treesitter
+from _griffe.docstrings import google, numpy
 from _griffe.enumerations import DocstringSectionKind
-from _griffe.docstrings import numpy, google
+
+from mkdocstrings_handlers.matlab import collect, handler, models, treesitter
+from mkdocstrings_handlers.matlab.handler import get_handler
 
 __all__ = ["get_handler", "collect", "handler", "models", "treesitter"]
 

src/mkdocstrings_handlers/matlab/collect.py

@@ -3,35 +3,35 @@
 from collections import defaultdict, deque
 from copy import copy, deepcopy
 from pathlib import Path
-from typing import Any, Mapping, Sequence, Callable, TypeVar
+from typing import Any, Callable, Mapping, Sequence, TypeVar
 
-from _griffe.collections import LinesCollection as GLC, ModulesCollection
+from _griffe.collections import LinesCollection as GLC
+from _griffe.collections import ModulesCollection
 from _griffe.docstrings.models import (
+    DocstringParameter,
+    DocstringReturn,
     DocstringSectionOtherParameters,
     DocstringSectionParameters,
     DocstringSectionReturns,
-    DocstringParameter,
-    DocstringReturn,
 )
 from _griffe.enumerations import DocstringSectionKind
 from _griffe.expressions import Expr
 
 from mkdocstrings_handlers.matlab.enums import ParameterKind
 from mkdocstrings_handlers.matlab.models import (
-    _ParentGrabber,
     Class,
     Classfolder,
     Docstring,
     DocstringSectionText,
-    Function,
     Folder,
+    Function,
     MatlabMixin,
     Namespace,
     PathMixin,
+    _ParentGrabber,
 )
 from mkdocstrings_handlers.matlab.treesitter import FileParser
 
-
 PathType = TypeVar("PathType", bound=PathMixin)
 
 __all__ = ["LinesCollection", "PathCollection"]
@@ -198,7 +198,6 @@ def resolve(
         elif self._config_path is not None and "/" in identifier:
             absolute_path = (self._config_path / Path(identifier)).resolve()
             if absolute_path.exists():
- 
                 if absolute_path.suffix:
                     path, member = absolute_path.parent, absolute_path.stem
                 else:
@@ -549,9 +548,7 @@ def addpath(self, path: str | Path, to_end: bool = False, recursive: bool = Fals
             ]:
                 if member.parent.is_relative_to(self._config_path):
                     if member.parent not in self._folders:
-                        self._folders[member.parent] = LazyModel(
-                            member.parent, self
-                        )
+                        self._folders[member.parent] = LazyModel(member.parent, self)
                 else:
                     pass  # TODO: Issue warning?
 

src/mkdocstrings_handlers/matlab/enums.py

@@ -1,12 +1,12 @@
 from enum import Enum
-from _griffe.enumerations import Kind as GriffeKind
 
 
 class Kind(str, Enum):
     """
     An enumeration representing different kinds of MATLAB code elements.
     This enumeration is a subclass of the Griffe `Kind` enumeration, and extends it with additional values.
     """
+
     MODULE = "module"
     """Modules."""
     CLASS = "class"

src/mkdocstrings_handlers/matlab/handler.py

@@ -1,18 +1,18 @@
 """The mkdocstrings handler for processing MATLAB code documentation."""
 
-from pathlib import Path
+import re
 from collections import ChainMap
+from pathlib import Path
+from pprint import pprint
+from typing import Any, ClassVar, Mapping
+
 from jinja2.loaders import FileSystemLoader
 from markdown import Markdown
 from mkdocs.exceptions import PluginError
-from mkdocstrings.handlers.base import BaseHandler, CollectorItem, CollectionError
-from mkdocstrings_handlers.python import rendering
-from typing import Any, ClassVar, Mapping
-from pprint import pprint
-
-import re
+from mkdocstrings.handlers.base import BaseHandler, CollectionError, CollectorItem
 
 from mkdocstrings_handlers.matlab.collect import LinesCollection, PathCollection
+from mkdocstrings_handlers.python import rendering
 
 
 class MatlabHandler(BaseHandler):
@@ -363,7 +363,7 @@ def collect(self, identifier: str, config: Mapping[str, Any]) -> CollectorItem:
         except SyntaxError as ex:
             msg = str(ex)
             if ex.text:
-                msg += ':\n' + ex.text
+                msg += ":\n" + ex.text
             raise CollectionError(msg) from ex
         except Exception as ex:
             raise CollectionError(str(ex)) from ex

src/mkdocstrings_handlers/matlab/models.py

@@ -153,12 +153,16 @@ def namespaces(self) -> dict[str, "Namespace"]:
 
     @property
     def scripts(self) -> dict[str, "Script"]:
-        return {name: member for name, member in self.all_members.items() if member.kind is Kind.SCRIPT} # type: ignore[misc]
+        return {
+            name: member
+            for name, member in self.all_members.items()
+            if member.kind is Kind.SCRIPT
+        }  # type: ignore[misc]
 
     @property
     def is_script(self) -> bool:
         return False
-    
+
     @property
     def is_namespace(self) -> bool:
         return False
@@ -288,7 +292,8 @@ class Script(MatlabMixin, PathMixin, MatlabObject):
     This class inherits from `PathMixin` and `MatlabObject` to provide
     functionality specific to MATLAB scripts.
     """
-    kind = Kind.SCRIPT # type: ignore
+
+    kind = Kind.SCRIPT  # type: ignore
 
     def __init__(self, *args: Any, **kwargs: Any) -> None:
         super().__init__(*args, **kwargs)
@@ -298,6 +303,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
     def is_script(self) -> bool:
         return True
 
+
 class Class(MatlabMixin, PathMixin, GriffeClass, MatlabObject):
     """
     Represents a MATLAB class with additional properties and methods for handling
@@ -458,7 +464,7 @@ def Private(self) -> bool:
         private = self.Access != AccessEnum.public
         get_private = self.GetAccess != AccessEnum.public
         return private or get_private
-    
+
     @property
     def is_private(self) -> bool:
         return self.Private or self.Hidden