Differentiate warnings when cleaning vs parsing blocks (felix-hilden#136)

felix-hilden · felix-hilden · commit 597afca9968b · 2023-02-05T10:38:45.000+02:00
diff --git a/docs/src/reference.rst b/docs/src/reference.rst
@@ -146,7 +146,8 @@ All warning subtypes below are in the ``codeautolink.*`` namespace
 and can be ignored with configuring ``suppress_warnings``.
 
 - ``invalid_argument``: issued when a directive is used incorrectly
-- ``parse_block``: issued when parsing a code block fails
+- ``clean_block``: issued when cleaning a block fails with a ``SyntaxError``
+- ``parse_block``: issued when parsing a block fails with a ``SyntaxError``
 - ``import_star``: issued when a library cannot be imported to determine
   the names that an ``import *`` would introduce
 - ``match_block``: issued when a block cannot be matched
diff --git a/docs/src/release_notes.rst b/docs/src/release_notes.rst
@@ -8,6 +8,10 @@ These release notes are based on
 sphinx-codeautolink adheres to
 `Semantic Versioning <https://semver.org>`_.
 
+Unreleased
+----------
+- Differentiate warning types of block cleaning and parsing (:issue:`136`)
+
 0.14.1 (2023-01-30)
 -------------------
 - Fix added debug info on failed resolving crashing the build (:issue:`134`)
diff --git a/src/sphinx_codeautolink/extension/block.py b/src/sphinx_codeautolink/extension/block.py
@@ -199,10 +199,9 @@ def parse_source(
             try:
                 source, clean_source = transformer(source)
             except SyntaxError as e:
-                show_source = self._format_source_for_error(source, prefaces)
-                msg = self._parsing_error_msg(e, language, show_source)
+                msg = self._parsing_error_msg(e, language, source)
                 logger.warning(
-                    msg, type=warn_type, subtype="parse_block", location=node
+                    msg, type=warn_type, subtype="clean_block", location=node
                 )
                 return
         else:
