remove '<' characters from log messages (#1005)

Author: oscarlevin

pretext/cli.py

@@ -267,7 +267,7 @@ def support() -> None:
         for exec_name in project.get_executables().model_dump():
             if utils.check_executable(exec_name) is None:
                 log.warning(
-                    f"Unable to locate the command for <{exec_name}> on your system."
+                    f"Unable to locate the command for `{exec_name}` on your system."
                 )
     else:
         log.info("No project.ptx found.")
@@ -429,7 +429,7 @@ def init(refresh: bool, files: List[str], system: bool) -> None:
     if project_path is None:
         log.info("Success! Open project.ptx to edit your project manifest.")
         log.info(
-            "Edit your <target/>s to point to the location of your PreTeXt source files."
+            "Edit your `target` elements to point to the location of your PreTeXt source files."
         )
     else:
         log.info(

pretext/project/__init__.py

@@ -360,7 +360,7 @@ def post_validate(self) -> None:
             if isinstance(d_list, list):
                 if len(d_list) != 1:
                     raise ValueError(
-                        "Only one <document-id> is allowed in a PreTeXt document."
+                        "Only one `document-id` tag is allowed in a PreTeXt document."
                     )
                 # NB as of 2025-04-08, we are no longer setting the output directory automatically for
                 # Runestone targets.  This must be managed by the project.ptx file or by a client script.
@@ -374,7 +374,7 @@ def post_validate(self) -> None:
                 # )
             else:
                 raise ValueError(
-                    "The <document-id> must be defined for the Runestone format."
+                    "The `document-id` tag must be defined for the Runestone format."
                 )
 
     def source_abspath(self) -> Path:
@@ -704,7 +704,7 @@ def build(
                 log.warning(
                     "You specified a publication file via a stringparam. "
                     + "This is ignored in favor of the publication file given by the "
-                    + "<publication> element in the project manifest."
+                    + "`publication` element in the project manifest."
                 )
 
             log.info(f"Preparing to build into {self.output_dir_abspath()}.")
@@ -1611,7 +1611,7 @@ def stage_deployment(self) -> None:
                         "Configurations are subject to change from version-to-version without notice."
                     )
                     log.warning(
-                        "Discussion: <https://github.com/PreTeXtBook/pretext-cli/discussions/766>"
+                        "Discussion: https://github.com/PreTeXtBook/pretext-cli/discussions/766"
                     )
                 with tempfile.TemporaryDirectory(prefix="ptxcli_") as tmp_dir_str:
                     log.info(f"Staging generated site at `{self.stage_abspath()}`.")

pretext/utils.py

@@ -185,7 +185,7 @@ def xml_syntax_is_valid(xmlfile: Path, root_tag: str = "pretext") -> bool:
         log.debug("XML syntax appears well formed.")
         if source_xml.getroot().tag != root_tag:
             log.error(
-                f'The file {xmlfile} does not have "<{root_tag}>" as its root element.  Did you use a subfile as your source?  Check the project manifest (project.ptx).'
+                f"The file {xmlfile} does not have `{root_tag}` element as its root element.  Did you use a subfile as your source?  Check the project manifest (project.ptx)."
             )
             return False
     # check for file IO error