Collapse single line docstrings

tests/ext_napoleon_pep526_data_google.py

@@ -1,5 +1,4 @@
-"""Test module for napoleon PEP 526 compatibility with google style
-"""
+"""Test module for napoleon PEP 526 compatibility with google style"""
 
 module_level_var: int = 99
 """This is an example module level variable"""

tests/ext_napoleon_pep526_data_numpy.py

@@ -1,5 +1,4 @@
-"""Test module for napoleon PEP 526 compatibility with numpy style
-"""
+"""Test module for napoleon PEP 526 compatibility with numpy style"""
 
 module_level_var: int = 99
 """This is an example module level variable"""

tests/test_api_translator.py

@@ -1,5 +1,4 @@
-"""Test the Sphinx API for translator.
-"""
+"""Test the Sphinx API for translator."""
 
 import sys
 

tests/test_application.py

@@ -1,5 +1,4 @@
-"""Test the Sphinx class.
-"""
+"""Test the Sphinx class."""
 
 from unittest.mock import Mock
 

tests/test_build.py

@@ -1,5 +1,4 @@
-"""Test all builders.
-"""
+"""Test all builders."""
 
 import sys
 from textwrap import dedent

tests/test_build_changes.py

@@ -1,5 +1,4 @@
-"""Test the ChangesBuilder class.
-"""
+"""Test the ChangesBuilder class."""
 
 import pytest
 

tests/test_build_dirhtml.py

@@ -1,5 +1,4 @@
-"""Test dirhtml builder.
-"""
+"""Test dirhtml builder."""
 
 import posixpath
 

tests/test_build_epub.py

@@ -1,5 +1,4 @@
-"""Test the HTML builder and check output against XPath.
-"""
+"""Test the HTML builder and check output against XPath."""
 
 import os
 import subprocess

tests/test_build_gettext.py

@@ -1,5 +1,4 @@
-"""Test the build process with gettext builder with the test root.
-"""
+"""Test the build process with gettext builder with the test root."""
 
 import gettext
 import os

tests/test_build_html.py

@@ -1,5 +1,4 @@
-"""Test the HTML builder and check output against XPath.
-"""
+"""Test the HTML builder and check output against XPath."""
 
 import os
 import re

tests/test_build_latex.py

@@ -1,5 +1,4 @@
-"""Test the build process with LaTeX builder with the test root.
-"""
+"""Test the build process with LaTeX builder with the test root."""
 
 import os
 import re

tests/test_build_linkcheck.py

@@ -1,5 +1,4 @@
-"""Test the build process with manpage builder with the test root.
-"""
+"""Test the build process with manpage builder with the test root."""
 
 import http.server
 import json

tests/test_build_manpage.py

@@ -1,5 +1,4 @@
-"""Test the build process with manpage builder with the test root.
-"""
+"""Test the build process with manpage builder with the test root."""
 
 import pytest
 

tests/test_build_texinfo.py

@@ -1,5 +1,4 @@
-"""Test the build process with Texinfo builder with the test root.
-"""
+"""Test the build process with Texinfo builder with the test root."""
 
 import os
 import re

tests/test_build_text.py

@@ -1,5 +1,4 @@
-"""Test the build process with Text builder with the test root.
-"""
+"""Test the build process with Text builder with the test root."""
 
 import pytest
 from docutils.utils import column_width

tests/test_builder.py

@@ -1,5 +1,4 @@
-"""Test the Builder class.
-"""
+"""Test the Builder class."""
 import pytest
 
 

tests/test_catalogs.py

@@ -1,5 +1,4 @@
-"""Test the base build process.
-"""
+"""Test the base build process."""
 import shutil
 
 import pytest

tests/test_config.py

@@ -1,5 +1,4 @@
-"""Test the sphinx.config.Config class.
-"""
+"""Test the sphinx.config.Config class."""
 
 from unittest import mock
 

tests/test_correct_year.py

@@ -1,5 +1,4 @@
-"""Test copyright year adjustment
-"""
+"""Test copyright year adjustment"""
 import pytest
 
 

tests/test_directive_code.py

@@ -1,5 +1,4 @@
-"""Test the code-block directive.
-"""
+"""Test the code-block directive."""
 
 import os
 

tests/test_directive_only.py

@@ -1,5 +1,4 @@
-"""Test the only directive with the test root.
-"""
+"""Test the only directive with the test root."""
 
 import re
 

tests/test_directive_other.py

@@ -1,5 +1,4 @@
-"""Test the other directives.
-"""
+"""Test the other directives."""
 
 import pytest
 from docutils import nodes

tests/test_directive_patch.py

@@ -1,5 +1,4 @@
-"""Test the patched directives.
-"""
+"""Test the patched directives."""
 
 import pytest
 from docutils import nodes

tests/test_docutilsconf.py

@@ -1,5 +1,4 @@
-"""Test docutils.conf support for several writers.
-"""
+"""Test docutils.conf support for several writers."""
 
 import pytest
 from docutils import nodes

tests/test_domain_c.py

@@ -1,5 +1,4 @@
-"""Tests the C Domain
-"""
+"""Tests the C Domain"""
 
 import itertools
 import zlib

tests/test_domain_cpp.py

@@ -1,5 +1,4 @@
-"""Tests the C++ Domain
-"""
+"""Tests the C++ Domain"""
 
 import itertools
 import re

tests/test_domain_js.py

@@ -1,5 +1,4 @@
-"""Tests the JavaScript Domain
-"""
+"""Tests the JavaScript Domain"""
 
 from unittest.mock import Mock
 

tests/test_domain_py.py

@@ -1,5 +1,4 @@
-"""Tests the Python Domain
-"""
+"""Tests the Python Domain"""
 
 import re
 import sys

tests/test_domain_rst.py

@@ -1,5 +1,4 @@
-"""Tests the reStructuredText domain.
-"""
+"""Tests the reStructuredText domain."""
 
 from sphinx import addnodes
 from sphinx.addnodes import (desc, desc_addname, desc_annotation, desc_content, desc_name,

tests/test_domain_std.py

@@ -1,5 +1,4 @@
-"""Tests the std domain
-"""
+"""Tests the std domain"""
 
 from unittest import mock
 

tests/test_environment.py

@@ -1,5 +1,4 @@
-"""Test the BuildEnvironment class.
-"""
+"""Test the BuildEnvironment class."""
 import os
 import shutil
 

tests/test_environment_indexentries.py

@@ -1,5 +1,4 @@
-"""Test the sphinx.environment.managers.indexentries.
-"""
+"""Test the sphinx.environment.managers.indexentries."""
 
 import pytest
 

tests/test_environment_toctree.py

@@ -1,5 +1,4 @@
-"""Test the sphinx.environment.managers.toctree.
-"""
+"""Test the sphinx.environment.managers.toctree."""
 
 import pytest
 from docutils import nodes

tests/test_events.py

@@ -1,5 +1,4 @@
-"""Test the EventManager class.
-"""
+"""Test the EventManager class."""
 
 import pytest
 

tests/test_ext_apidoc.py

@@ -1,5 +1,4 @@
-"""Test the sphinx.apidoc module.
-"""
+"""Test the sphinx.apidoc module."""
 
 from collections import namedtuple
 

tests/test_ext_autodoc_configs.py

@@ -1,5 +1,4 @@
-"""Test the autodoc extension.  This tests mainly for config variables
-"""
+"""Test the autodoc extension.  This tests mainly for config variables"""
 
 import platform
 import sys

tests/test_ext_autodoc_events.py

@@ -1,5 +1,4 @@
-"""Test the autodoc extension.  This tests mainly for autodoc events
-"""
+"""Test the autodoc extension.  This tests mainly for autodoc events"""
 
 import pytest
 

tests/test_ext_autodoc_mock.py

@@ -1,5 +1,4 @@
-"""Test the autodoc extension.
-"""
+"""Test the autodoc extension."""
 
 import abc
 import sys

tests/test_ext_autodoc_preserve_defaults.py

@@ -1,5 +1,4 @@
-"""Test the autodoc extension.
-"""
+"""Test the autodoc extension."""
 
 import sys
 

tests/test_ext_autosectionlabel.py

@@ -1,5 +1,4 @@
-"""Test sphinx.ext.autosectionlabel extension.
-"""
+"""Test sphinx.ext.autosectionlabel extension."""
 
 import re
 

tests/test_ext_autosummary.py

@@ -1,5 +1,4 @@
-"""Test the autosummary extension.
-"""
+"""Test the autosummary extension."""
 
 import sys
 from io import StringIO

tests/test_ext_coverage.py

@@ -1,5 +1,4 @@
-"""Test the coverage builder.
-"""
+"""Test the coverage builder."""
 
 import pickle
 

tests/test_ext_doctest.py

@@ -1,5 +1,4 @@
-"""Test the doctest extension.
-"""
+"""Test the doctest extension."""
 import os
 from collections import Counter
 

tests/test_ext_duration.py

@@ -1,5 +1,4 @@
-"""Test sphinx.ext.duration extension.
-"""
+"""Test sphinx.ext.duration extension."""
 
 import re
 

tests/test_ext_githubpages.py

@@ -1,5 +1,4 @@
-"""Test sphinx.ext.githubpages extension.
-"""
+"""Test sphinx.ext.githubpages extension."""
 
 import pytest
 

tests/test_ext_graphviz.py

@@ -1,5 +1,4 @@
-"""Test sphinx.ext.graphviz extension.
-"""
+"""Test sphinx.ext.graphviz extension."""
 
 import re
 

tests/test_ext_ifconfig.py

@@ -1,5 +1,4 @@
-"""Test sphinx.ext.ifconfig extension.
-"""
+"""Test sphinx.ext.ifconfig extension."""
 
 import pytest
 

tests/test_ext_imgconverter.py

@@ -1,5 +1,4 @@
-"""Test sphinx.ext.imgconverter extension.
-"""
+"""Test sphinx.ext.imgconverter extension."""
 
 import os
 

tests/test_ext_inheritance_diagram.py

@@ -1,5 +1,4 @@
-"""Test sphinx.ext.inheritance_diagram extension.
-"""
+"""Test sphinx.ext.inheritance_diagram extension."""
 
 import os
 import re

tests/test_ext_intersphinx.py

@@ -1,5 +1,4 @@
-"""Test the intersphinx extension.
-"""
+"""Test the intersphinx extension."""
 
 import http.server
 import os

tests/test_ext_math.py

@@ -1,5 +1,4 @@
-"""Test math extensions.
-"""
+"""Test math extensions."""
 
 import re
 import subprocess

tests/test_ext_todo.py

@@ -1,5 +1,4 @@
-"""Test sphinx.ext.todo extension.
-"""
+"""Test sphinx.ext.todo extension."""
 
 import re
 

tests/test_ext_viewcode.py

@@ -1,5 +1,4 @@
-"""Test sphinx.ext.viewcode extension.
-"""
+"""Test sphinx.ext.viewcode extension."""
 
 import re
 

tests/test_extension.py

@@ -1,5 +1,4 @@
-"""Test sphinx.extension module.
-"""
+"""Test sphinx.extension module."""
 
 import pytest
 

tests/test_highlighting.py

@@ -1,5 +1,4 @@
-"""Test the Pygments highlighting bridge.
-"""
+"""Test the Pygments highlighting bridge."""
 
 from unittest import mock
 

tests/test_locale.py

@@ -1,5 +1,4 @@
-"""Test locale.
-"""
+"""Test locale."""
 
 import pytest
 

tests/test_markup.py

@@ -1,5 +1,4 @@
-"""Test various Sphinx-specific markup extensions.
-"""
+"""Test various Sphinx-specific markup extensions."""
 
 import re
 

tests/test_metadata.py

@@ -1,5 +1,4 @@
-"""Test our handling of metadata in files with bibliographic metadata.
-"""
+"""Test our handling of metadata in files with bibliographic metadata."""
 
 # adapted from an example of bibliographic metadata at
 # https://docutils.sourceforge.io/docs/user/rst/demo.txt

tests/test_parser.py

@@ -1,5 +1,4 @@
-"""Tests parsers module.
-"""
+"""Tests parsers module."""
 
 from unittest.mock import Mock, patch
 

tests/test_project.py

@@ -1,5 +1,4 @@
-"""Tests project module.
-"""
+"""Tests project module."""
 
 from collections import OrderedDict
 

tests/test_pycode.py

@@ -1,5 +1,4 @@
-"""Test pycode.
-"""
+"""Test pycode."""
 
 import os
 import sys

tests/test_pycode_ast.py

@@ -1,5 +1,4 @@
-"""Test pycode.ast
-"""
+"""Test pycode.ast"""
 
 import sys
 

tests/test_pycode_parser.py

@@ -1,5 +1,4 @@
-"""Test pycode.parser.
-"""
+"""Test pycode.parser."""
 
 from sphinx.pycode.parser import Parser
 from sphinx.util.inspect import signature_from_str

tests/test_quickstart.py

@@ -1,5 +1,4 @@
-"""Test the sphinx.quickstart module.
-"""
+"""Test the sphinx.quickstart module."""
 
 import time
 from io import StringIO

tests/test_roles.py

@@ -1,5 +1,4 @@
-"""Test sphinx.roles
-"""
+"""Test sphinx.roles"""
 
 from unittest.mock import Mock
 

tests/test_search.py

@@ -1,5 +1,4 @@
-"""Test the search index builder.
-"""
+"""Test the search index builder."""
 
 from collections import namedtuple
 from io import BytesIO

tests/test_setup_command.py

@@ -1,5 +1,4 @@
-"""Test setup_command for distutils.
-"""
+"""Test setup_command for distutils."""
 
 import os
 import subprocess

tests/test_smartquotes.py

@@ -1,5 +1,4 @@
-"""Test smart quotes.
-"""
+"""Test smart quotes."""
 
 import pytest
 from html5lib import HTMLParser

tests/test_templating.py

@@ -1,5 +1,4 @@
-"""Test templating.
-"""
+"""Test templating."""
 
 import pytest
 

tests/test_theming.py

@@ -1,5 +1,4 @@
-"""Test the Theme class.
-"""
+"""Test the Theme class."""
 
 import os
 

tests/test_toctree.py

@@ -1,5 +1,4 @@
-"""Test the HTML builder and check output against XPath.
-"""
+"""Test the HTML builder and check output against XPath."""
 import re
 
 import pytest

tests/test_transforms_post_transforms.py

@@ -1,5 +1,4 @@
-"""Tests the post_transforms
-"""
+"""Tests the post_transforms"""
 
 import pytest
 from docutils import nodes

tests/test_util.py

@@ -1,5 +1,4 @@
-"""Tests util functions.
-"""
+"""Tests util functions."""
 
 import os
 import tempfile

tests/test_util_docstrings.py

@@ -1,5 +1,4 @@
-"""Test sphinx.util.docstrings.
-"""
+"""Test sphinx.util.docstrings."""
 
 from sphinx.util.docstrings import prepare_commentdoc, prepare_docstring, separate_metadata
 

tests/test_util_docutils.py

@@ -1,5 +1,4 @@
-"""Tests util.utils functions.
-"""
+"""Tests util.utils functions."""
 
 import os
 

tests/test_util_fileutil.py

@@ -1,5 +1,4 @@
-"""Tests sphinx.util.fileutil functions.
-"""
+"""Tests sphinx.util.fileutil functions."""
 
 from unittest import mock
 

tests/test_util_i18n.py

@@ -1,5 +1,4 @@
-"""Test i18n util.
-"""
+"""Test i18n util."""
 
 import datetime
 import os

tests/test_util_images.py

@@ -1,5 +1,4 @@
-"""Test images util.
-"""
+"""Test images util."""
 
 import pytest
 

tests/test_util_inspect.py

@@ -1,5 +1,4 @@
-"""Tests util.inspect functions.
-"""
+"""Tests util.inspect functions."""
 
 import ast
 import datetime

tests/test_util_inventory.py

@@ -1,5 +1,4 @@
-"""Test inventory util functions.
-"""
+"""Test inventory util functions."""
 
 import posixpath
 import zlib

tests/test_util_logging.py

@@ -1,5 +1,4 @@
-"""Test logging util.
-"""
+"""Test logging util."""
 
 import codecs
 import os

tests/test_util_matching.py

@@ -1,5 +1,4 @@
-"""Tests sphinx.util.matching functions.
-"""
+"""Tests sphinx.util.matching functions."""
 from sphinx.util.matching import Matcher, compile_matchers
 
 

tests/test_util_nodes.py

@@ -1,5 +1,4 @@
-"""Tests uti.nodes functions.
-"""
+"""Tests uti.nodes functions."""
 from textwrap import dedent
 from typing import Any
 

tests/test_util_rst.py

@@ -1,5 +1,4 @@
-"""Tests sphinx.util.rst functions.
-"""
+"""Tests sphinx.util.rst functions."""
 
 from docutils.statemachine import StringList
 from jinja2 import Environment

tests/test_util_template.py

@@ -1,5 +1,4 @@
-"""Tests sphinx.util.template functions.
-"""
+"""Tests sphinx.util.template functions."""
 
 from sphinx.util.template import ReSTRenderer
 

tests/test_util_typing.py

@@ -1,5 +1,4 @@
-"""Tests util.typing functions.
-"""
+"""Tests util.typing functions."""
 
 import sys
 from numbers import Integral

tests/test_versioning.py

@@ -1,5 +1,4 @@
-"""Test the versioning implementation.
-"""
+"""Test the versioning implementation."""
 
 import pickle
 

tests/test_writer_latex.py

@@ -1,5 +1,4 @@
-"""Test the LaTeX writer
-"""
+"""Test the LaTeX writer"""
 
 import pytest