Don't make YAMLCommentFormatter public.

Author: mauvilsa

CHANGELOG.rst

@@ -31,8 +31,9 @@ Changed
 Deprecated
 ^^^^^^^^^^
 - ``DefaultHelpFormatter.*_yaml*_comment*`` methods are deprecated and will be
-  removed in v5.0.0. Instead use the new class ``YAMLCommentFormatter`` (`#754
-  <https://github.com/omni-us/jsonargparse/pull/754>`__).
+  removed in v5.0.0. This logic has been moved to a new private class
+  ``YAMLCommentFormatter``. If deemed necessary, this class might be made public
+  in the future (`#754 <https://github.com/omni-us/jsonargparse/pull/754>`__).
 
 
 v4.40.2 (2025-08-06)

jsonargparse/_deprecated.py

@@ -710,22 +710,12 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self._yaml_formatter = YAMLCommentFormatter(self)
 
-    @deprecated(
-        """
-        The add_yaml_comments method is deprecated and will be removed in v5.0.0.
-        Use :class:`YAMLCommentFormatter` instead.
-    """
-    )
+    @deprecated("The add_yaml_comments method is deprecated and will be removed in v5.0.0.")
     def add_yaml_comments(self, cfg: str) -> str:
         """Adds help text as yaml comments."""
         return self._yaml_formatter.add_yaml_comments(cfg)
 
-    @deprecated(
-        """
-        The set_yaml_start_comment method is deprecated and will be removed in v5.0.0.
-        Use :class:`YAMLCommentFormatter` instead.
-    """
-    )
+    @deprecated("The set_yaml_start_comment method is deprecated and will be removed in v5.0.0.")
     def set_yaml_start_comment(self, text: str, cfg: ruyamlCommentedMap):
         """Sets the start comment to a ruyaml object.
 
@@ -735,12 +725,7 @@ def set_yaml_start_comment(self, text: str, cfg: ruyamlCommentedMap):
         """
         self._yaml_formatter.set_yaml_start_comment(text, cfg)
 
-    @deprecated(
-        """
-        The set_yaml_group_comment method is deprecated and will be removed in v5.0.0.
-        Use :class:`YAMLCommentFormatter` instead.
-    """
-    )
+    @deprecated("The set_yaml_group_comment method is deprecated and will be removed in v5.0.0.")
     def set_yaml_group_comment(self, text: str, cfg: ruyamlCommentedMap, key: str, depth: int):
         """Sets the comment for a group to a ruyaml object.
 
@@ -752,12 +737,7 @@ def set_yaml_group_comment(self, text: str, cfg: ruyamlCommentedMap, key: str, d
         """
         self._yaml_formatter.set_yaml_group_comment(text, cfg, key, depth)
 
-    @deprecated(
-        """
-        The set_yaml_argument_comment method is deprecated and will be removed in v5.0.0.
-        Use :class:`YAMLCommentFormatter` instead.
-    """
-    )
+    @deprecated("The set_yaml_argument_comment method is deprecated and will be removed in v5.0.0.")
     def set_yaml_argument_comment(self, text: str, cfg: ruyamlCommentedMap, key: str, depth: int):
         """Sets the comment for an argument to a ruyaml object.
 

jsonargparse/_formatters.py

@@ -37,7 +37,7 @@
 from ._type_checking import ArgumentParser, ruyamlCommentedMap
 from ._typehints import ActionTypeHint, type_to_str
 
-__all__ = ["DefaultHelpFormatter", "YAMLCommentFormatter"]
+__all__ = ["DefaultHelpFormatter"]
 
 
 empty_help: str = "_EMPTY_HELP_"

jsonargparse_tests/test_deprecated.py

@@ -745,23 +745,19 @@ def test_DefaultHelpFormatter_yaml_comments(parser):
     with catch_warnings(record=True) as w:
         formatter.add_yaml_comments("arg: 1")
     assert "add_yaml_comments method is deprecated and will be removed in v5.0.0" in str(w[-1].message)
-    assert ":class:`YAMLCommentFormatter`" in str(w[-1].message)
     assert "formatter.add_yaml_comments(" in source[w[-1].lineno - 1]
 
     with catch_warnings(record=True) as w:
         formatter.set_yaml_start_comment("start", cfg)
     assert "set_yaml_start_comment method is deprecated and will be removed in v5.0.0" in str(w[-1].message)
-    assert ":class:`YAMLCommentFormatter`" in str(w[-1].message)
     assert "formatter.set_yaml_start_comment(" in source[w[-1].lineno - 1]
 
     with catch_warnings(record=True) as w:
         formatter.set_yaml_group_comment("group", cfg, "arg", 0)
     assert "set_yaml_group_comment method is deprecated and will be removed in v5.0.0" in str(w[-1].message)
-    assert ":class:`YAMLCommentFormatter`" in str(w[-1].message)
     assert "formatter.set_yaml_group_comment(" in source[w[-1].lineno - 1]
 
     with catch_warnings(record=True) as w:
         formatter.set_yaml_argument_comment("arg", cfg, "arg", 0)
     assert "set_yaml_argument_comment method is deprecated and will be removed in v5.0.0" in str(w[-1].message)
-    assert ":class:`YAMLCommentFormatter`" in str(w[-1].message)
     assert "formatter.set_yaml_argument_comment(" in source[w[-1].lineno - 1]