SF.net SVN: docutils:[10116 ] trunk/docutils

Revision: 10116
          http://sourceforge.net/p/docutils/code/10116
Author:   grubert
Date:     2025-05-01 09:32:29 +0000 (Thu, 01 May 2025)
Log Message:
-----------
code/comment cleanup

Modified Paths:
--------------
    trunk/docutils/docutils/writers/manpage.py
    trunk/docutils/test/functional/expected/standalone_rst_manpage.man
    trunk/docutils/test/test_writers/test_manpage.py

Modified: trunk/docutils/docutils/writers/manpage.py
===================================================================
--- trunk/docutils/docutils/writers/manpage.py	2025-05-01 09:30:28 UTC (rev 10115)
+++ trunk/docutils/docutils/writers/manpage.py	2025-05-01 09:32:29 UTC (rev 10116)
@@ -121,12 +121,11 @@
         None,
         (('Use man macros .UR/.UE and .MT/.ME for references ',
           ['--macro-references'],
-          {'dest': 'use_reference_macros',
-           'default': False, 'action': 'store_true',
+          {'default': False, 'action': 'store_true',
            'validator': frontend.validate_boolean}),
          ('Put references in plain text form.',
           ['--text-references'],
-          {'dest': 'use_reference_macros',
+          {'dest': 'macro_references',
            'action': 'store_false',
            'validator': frontend.validate_boolean}),
          ),
@@ -213,14 +212,14 @@
     words_and_spaces = re.compile(r'\S+| +|\n')
     possibly_a_roff_command = re.compile(r'\.\w')
     document_start = (
-        'Man page generated from reStructuredText by manpage writer\n'
-        f'from docutils {docutils.__version__}.'
+        'Man page generated from reStructuredText\n'
+        f'by the Docutils {docutils.__version__} manpage writer.'
     )
 
     def __init__(self, document) -> None:
         nodes.NodeVisitor.__init__(self, document)
         self.settings = settings = document.settings
-        if settings.use_reference_macros:
+        if settings.macro_references:
             self.visit_reference = self._visit_reference_with_macro
             self.depart_reference = self._depart_reference_with_macro
         else:

Modified: trunk/docutils/test/functional/expected/standalone_rst_manpage.man
===================================================================
--- trunk/docutils/test/functional/expected/standalone_rst_manpage.man	2025-05-01 09:30:28 UTC (rev 10115)
+++ trunk/docutils/test/functional/expected/standalone_rst_manpage.man	2025-05-01 09:32:29 UTC (rev 10116)
@@ -1,5 +1,5 @@
-.\" Man page generated from reStructuredText by manpage writer
-.\" from docutils 0.22b.dev.
+.\" Man page generated from reStructuredText
+.\" by the Docutils 0.22b.dev manpage writer.
 .
 .
 .nr rst2man-indent-level 0

Modified: trunk/docutils/test/test_writers/test_manpage.py
===================================================================
--- trunk/docutils/test/test_writers/test_manpage.py	2025-05-01 09:30:28 UTC (rev 10115)
+++ trunk/docutils/test/test_writers/test_manpage.py	2025-05-01 09:32:29 UTC (rev 10116)
@@ -55,6 +55,7 @@
                         settings_overrides={
                             '_disable_config': True,
                             'strict_visitor': True,
+                            'use_reference_macros': False,
                         }).decode()
                     self.assertEqual(case_expected, output)
 
@@ -68,8 +69,9 @@
                         settings_overrides={
                             '_disable_config': True,
                             'strict_visitor': True,
-                            'use_reference_macros': True,
-                        }).decode()
+                            'macro_references': True,
+                            'output_encoding': "unicode",
+                        })
                     self.assertEqual(case_expected, output)
 
     def test_system_msgs(self):
@@ -85,7 +87,8 @@
                             'strict_visitor': True,
                             'report_level': 1,
                             'warning_stream': warnings,
-                        }).decode()
+                            'output_encoding': "unicode",
+                        })
                     self.assertEqual(case_expected, output)
                     warnings.seek(0)
                     self.assertEqual(
@@ -93,8 +96,8 @@
                             warnings.readlines())
 
 
-document_start = r""".\" Man page generated from reStructuredText by manpage writer
-.\" from docutils 0.22b.dev.
+document_start = r""".\" Man page generated from reStructuredText
+.\" by the Docutils 0.22b.dev manpage writer.
 .
 """
 

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.