summaryrefslogtreecommitdiff
path: root/sphinx/util
diff options
context:
space:
mode:
authorAdam Turner <9087854+aa-turner@users.noreply.github.com>2022-02-20 03:05:56 +0000
committerAdam Turner <9087854+aa-turner@users.noreply.github.com>2022-02-20 03:13:45 +0000
commit5775912455c25ee82734e1ff319a32f55946d79b (patch)
treee75fe3b61f6d92afb29fd38478e03d96179af015 /sphinx/util
parent6bb7b891a16fbcd5fad1f88fb472505549b9c084 (diff)
downloadsphinx-git-5775912455c25ee82734e1ff319a32f55946d79b.tar.gz
Collapse single line docstrings
Diffstat (limited to 'sphinx/util')
-rw-r--r--sphinx/util/__init__.py3
-rw-r--r--sphinx/util/build_phase.py3
-rw-r--r--sphinx/util/cfamily.py3
-rw-r--r--sphinx/util/compat.py3
-rw-r--r--sphinx/util/console.py3
-rw-r--r--sphinx/util/docstrings.py3
-rw-r--r--sphinx/util/docutils.py3
-rw-r--r--sphinx/util/fileutil.py3
-rw-r--r--sphinx/util/i18n.py3
-rw-r--r--sphinx/util/images.py3
-rw-r--r--sphinx/util/inspect.py3
-rw-r--r--sphinx/util/inventory.py3
-rw-r--r--sphinx/util/logging.py3
-rw-r--r--sphinx/util/matching.py3
-rw-r--r--sphinx/util/math.py3
-rw-r--r--sphinx/util/nodes.py3
-rw-r--r--sphinx/util/osutil.py3
-rw-r--r--sphinx/util/parallel.py3
-rw-r--r--sphinx/util/png.py3
-rw-r--r--sphinx/util/pycompat.py3
-rw-r--r--sphinx/util/requests.py3
-rw-r--r--sphinx/util/rst.py3
-rw-r--r--sphinx/util/stemmer/__init__.py3
-rw-r--r--sphinx/util/template.py3
-rw-r--r--sphinx/util/texescape.py3
-rw-r--r--sphinx/util/typing.py3
26 files changed, 26 insertions, 52 deletions
diff --git a/sphinx/util/__init__.py b/sphinx/util/__init__.py
index 9dd30289a..ee98c29c8 100644
--- a/sphinx/util/__init__.py
+++ b/sphinx/util/__init__.py
@@ -1,5 +1,4 @@
-"""Utility functions for Sphinx.
-"""
+"""Utility functions for Sphinx."""
import functools
import hashlib
diff --git a/sphinx/util/build_phase.py b/sphinx/util/build_phase.py
index 8a45eabb2..7f80aa576 100644
--- a/sphinx/util/build_phase.py
+++ b/sphinx/util/build_phase.py
@@ -1,5 +1,4 @@
-"""Build phase of Sphinx application.
-"""
+"""Build phase of Sphinx application."""
from enum import IntEnum
diff --git a/sphinx/util/cfamily.py b/sphinx/util/cfamily.py
index c382a5634..38dc3fd21 100644
--- a/sphinx/util/cfamily.py
+++ b/sphinx/util/cfamily.py
@@ -1,5 +1,4 @@
-"""Utility functions common to the C and C++ domains.
-"""
+"""Utility functions common to the C and C++ domains."""
import re
from copy import deepcopy
diff --git a/sphinx/util/compat.py b/sphinx/util/compat.py
index 58ca9e1b0..7f332fda7 100644
--- a/sphinx/util/compat.py
+++ b/sphinx/util/compat.py
@@ -1,5 +1,4 @@
-"""modules for backward compatibility
-"""
+"""modules for backward compatibility"""
import sys
from typing import TYPE_CHECKING, Any, Dict
diff --git a/sphinx/util/console.py b/sphinx/util/console.py
index 22bb01514..cc22390a5 100644
--- a/sphinx/util/console.py
+++ b/sphinx/util/console.py
@@ -1,5 +1,4 @@
-"""Format colored console output.
-"""
+"""Format colored console output."""
import os
import re
diff --git a/sphinx/util/docstrings.py b/sphinx/util/docstrings.py
index d952fa11b..11c823b33 100644
--- a/sphinx/util/docstrings.py
+++ b/sphinx/util/docstrings.py
@@ -1,5 +1,4 @@
-"""Utilities for docstring processing.
-"""
+"""Utilities for docstring processing."""
import re
import sys
diff --git a/sphinx/util/docutils.py b/sphinx/util/docutils.py
index 07a17be79..654a7a98b 100644
--- a/sphinx/util/docutils.py
+++ b/sphinx/util/docutils.py
@@ -1,5 +1,4 @@
-"""Utility functions for docutils.
-"""
+"""Utility functions for docutils."""
import os
import re
diff --git a/sphinx/util/fileutil.py b/sphinx/util/fileutil.py
index c3ce9633c..f706fa69a 100644
--- a/sphinx/util/fileutil.py
+++ b/sphinx/util/fileutil.py
@@ -1,5 +1,4 @@
-"""File utility functions for Sphinx.
-"""
+"""File utility functions for Sphinx."""
import os
import posixpath
diff --git a/sphinx/util/i18n.py b/sphinx/util/i18n.py
index a7706e899..f3bb002a3 100644
--- a/sphinx/util/i18n.py
+++ b/sphinx/util/i18n.py
@@ -1,5 +1,4 @@
-"""Builder superclass for all builders.
-"""
+"""Builder superclass for all builders."""
import os
import re
diff --git a/sphinx/util/images.py b/sphinx/util/images.py
index a6d0918a0..2def252f4 100644
--- a/sphinx/util/images.py
+++ b/sphinx/util/images.py
@@ -1,5 +1,4 @@
-"""Image utility functions for Sphinx.
-"""
+"""Image utility functions for Sphinx."""
import base64
import imghdr
diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py
index c9a4eb725..5b4e2586e 100644
--- a/sphinx/util/inspect.py
+++ b/sphinx/util/inspect.py
@@ -1,5 +1,4 @@
-"""Helpers for inspecting Python modules.
-"""
+"""Helpers for inspecting Python modules."""
import builtins
import contextlib
diff --git a/sphinx/util/inventory.py b/sphinx/util/inventory.py
index d46a0916d..7827aec74 100644
--- a/sphinx/util/inventory.py
+++ b/sphinx/util/inventory.py
@@ -1,5 +1,4 @@
-"""Inventory utility functions for Sphinx.
-"""
+"""Inventory utility functions for Sphinx."""
import os
import re
import zlib
diff --git a/sphinx/util/logging.py b/sphinx/util/logging.py
index 3e1dad784..37fa672af 100644
--- a/sphinx/util/logging.py
+++ b/sphinx/util/logging.py
@@ -1,5 +1,4 @@
-"""Logging utility functions for Sphinx.
-"""
+"""Logging utility functions for Sphinx."""
import logging
import logging.handlers
diff --git a/sphinx/util/matching.py b/sphinx/util/matching.py
index 4aede2763..53a893338 100644
--- a/sphinx/util/matching.py
+++ b/sphinx/util/matching.py
@@ -1,5 +1,4 @@
-"""Pattern-matching utility functions for Sphinx.
-"""
+"""Pattern-matching utility functions for Sphinx."""
import re
from typing import Callable, Dict, Iterable, List, Match, Optional, Pattern
diff --git a/sphinx/util/math.py b/sphinx/util/math.py
index 56523e10f..7caf662dc 100644
--- a/sphinx/util/math.py
+++ b/sphinx/util/math.py
@@ -1,5 +1,4 @@
-"""Utility functions for math.
-"""
+"""Utility functions for math."""
from docutils import nodes
diff --git a/sphinx/util/nodes.py b/sphinx/util/nodes.py
index aff3d1875..4abc3afa4 100644
--- a/sphinx/util/nodes.py
+++ b/sphinx/util/nodes.py
@@ -1,5 +1,4 @@
-"""Docutils node-related utility functions for Sphinx.
-"""
+"""Docutils node-related utility functions for Sphinx."""
import re
import unicodedata
diff --git a/sphinx/util/osutil.py b/sphinx/util/osutil.py
index 7ce114aa0..1af722fdc 100644
--- a/sphinx/util/osutil.py
+++ b/sphinx/util/osutil.py
@@ -1,5 +1,4 @@
-"""Operating system-related utility functions for Sphinx.
-"""
+"""Operating system-related utility functions for Sphinx."""
import contextlib
import filecmp
diff --git a/sphinx/util/parallel.py b/sphinx/util/parallel.py
index 39a5c741c..e4bd852b0 100644
--- a/sphinx/util/parallel.py
+++ b/sphinx/util/parallel.py
@@ -1,5 +1,4 @@
-"""Parallel building utilities.
-"""
+"""Parallel building utilities."""
import os
import time
diff --git a/sphinx/util/png.py b/sphinx/util/png.py
index 0234ab9fd..cb7ee8be4 100644
--- a/sphinx/util/png.py
+++ b/sphinx/util/png.py
@@ -1,5 +1,4 @@
-"""PNG image manipulation helpers.
-"""
+"""PNG image manipulation helpers."""
import binascii
import struct
diff --git a/sphinx/util/pycompat.py b/sphinx/util/pycompat.py
index 51f5af90d..aedbd143d 100644
--- a/sphinx/util/pycompat.py
+++ b/sphinx/util/pycompat.py
@@ -1,5 +1,4 @@
-"""Stuff for Python version compatibility.
-"""
+"""Stuff for Python version compatibility."""
import warnings
from typing import Any, Callable
diff --git a/sphinx/util/requests.py b/sphinx/util/requests.py
index 834274df2..b1bcb6bd3 100644
--- a/sphinx/util/requests.py
+++ b/sphinx/util/requests.py
@@ -1,5 +1,4 @@
-"""Simple requests package loader
-"""
+"""Simple requests package loader"""
import sys
import warnings
diff --git a/sphinx/util/rst.py b/sphinx/util/rst.py
index aa9b335bc..b44cf9848 100644
--- a/sphinx/util/rst.py
+++ b/sphinx/util/rst.py
@@ -1,5 +1,4 @@
-"""reST helper functions.
-"""
+"""reST helper functions."""
import re
from collections import defaultdict
diff --git a/sphinx/util/stemmer/__init__.py b/sphinx/util/stemmer/__init__.py
index 16a8d7ac8..ff6c365c7 100644
--- a/sphinx/util/stemmer/__init__.py
+++ b/sphinx/util/stemmer/__init__.py
@@ -1,5 +1,4 @@
-"""Word stemming utilities for Sphinx.
-"""
+"""Word stemming utilities for Sphinx."""
from sphinx.util.stemmer.porter import PorterStemmer
diff --git a/sphinx/util/template.py b/sphinx/util/template.py
index 803fd4bad..5a73515b3 100644
--- a/sphinx/util/template.py
+++ b/sphinx/util/template.py
@@ -1,5 +1,4 @@
-"""Templates utility functions for Sphinx.
-"""
+"""Templates utility functions for Sphinx."""
import os
from functools import partial
diff --git a/sphinx/util/texescape.py b/sphinx/util/texescape.py
index b25cb62c3..83c78bb38 100644
--- a/sphinx/util/texescape.py
+++ b/sphinx/util/texescape.py
@@ -1,5 +1,4 @@
-"""TeX escaping helper.
-"""
+"""TeX escaping helper."""
import re
from typing import Dict
diff --git a/sphinx/util/typing.py b/sphinx/util/typing.py
index 203205990..1534b2c8e 100644
--- a/sphinx/util/typing.py
+++ b/sphinx/util/typing.py
@@ -1,5 +1,4 @@
-"""The composite types for Sphinx.
-"""
+"""The composite types for Sphinx."""
import sys
import typing