From 6b8bccec5977f608f0b1e33f31a4888a2ea0d141 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sat, 19 Feb 2022 22:44:45 +0000 Subject: Remove module titles in docstrings --- sphinx/errors.py | 3 --- 1 file changed, 3 deletions(-) (limited to 'sphinx/errors.py') diff --git a/sphinx/errors.py b/sphinx/errors.py index c90dd10d0..f89804c7f 100644 --- a/sphinx/errors.py +++ b/sphinx/errors.py @@ -1,7 +1,4 @@ """ - sphinx.errors - ~~~~~~~~~~~~~ - Contains SphinxError and a few subclasses (in an extra module to avoid circular import problems). -- cgit v1.2.1 From 4f5a3269a6053fe659093096d9b635a2c8e7e55e Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 20 Feb 2022 00:06:24 +0000 Subject: Fix module docstring first line --- sphinx/errors.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'sphinx/errors.py') diff --git a/sphinx/errors.py b/sphinx/errors.py index f89804c7f..e0aab4b05 100644 --- a/sphinx/errors.py +++ b/sphinx/errors.py @@ -1,5 +1,4 @@ -""" - Contains SphinxError and a few subclasses (in an extra module to avoid +"""Contains SphinxError and a few subclasses (in an extra module to avoid circular import problems). :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -- cgit v1.2.1 From 5694e0ce60316b9cb9709d147e1a699ea9bde6da Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 20 Feb 2022 00:23:29 +0000 Subject: Fix module docstring indentation --- sphinx/errors.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'sphinx/errors.py') diff --git a/sphinx/errors.py b/sphinx/errors.py index e0aab4b05..30edd88a2 100644 --- a/sphinx/errors.py +++ b/sphinx/errors.py @@ -1,8 +1,8 @@ """Contains SphinxError and a few subclasses (in an extra module to avoid - circular import problems). +circular import problems). - :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. - :license: BSD, see LICENSE for details. +:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. +:license: BSD, see LICENSE for details. """ from typing import Any -- cgit v1.2.1 From b691ebcc3e440a678cd28432fed7279fa647e9cd Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 20 Feb 2022 02:57:02 +0000 Subject: Conform to PEP 257 summary line conventions --- sphinx/errors.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'sphinx/errors.py') diff --git a/sphinx/errors.py b/sphinx/errors.py index 30edd88a2..7ac997d3a 100644 --- a/sphinx/errors.py +++ b/sphinx/errors.py @@ -1,5 +1,4 @@ -"""Contains SphinxError and a few subclasses (in an extra module to avoid -circular import problems). +"""Contains SphinxError and a few subclasses. :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. -- cgit v1.2.1 From 6bb7b891a16fbcd5fad1f88fb472505549b9c084 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 20 Feb 2022 02:59:02 +0000 Subject: Remove copyright and licence fields --- sphinx/errors.py | 3 --- 1 file changed, 3 deletions(-) (limited to 'sphinx/errors.py') diff --git a/sphinx/errors.py b/sphinx/errors.py index 7ac997d3a..c5f8ea2fe 100644 --- a/sphinx/errors.py +++ b/sphinx/errors.py @@ -1,7 +1,4 @@ """Contains SphinxError and a few subclasses. - -:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. -:license: BSD, see LICENSE for details. """ from typing import Any -- cgit v1.2.1 From 5775912455c25ee82734e1ff319a32f55946d79b Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Sun, 20 Feb 2022 03:05:56 +0000 Subject: Collapse single line docstrings --- sphinx/errors.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'sphinx/errors.py') diff --git a/sphinx/errors.py b/sphinx/errors.py index c5f8ea2fe..a0263c613 100644 --- a/sphinx/errors.py +++ b/sphinx/errors.py @@ -1,5 +1,4 @@ -"""Contains SphinxError and a few subclasses. -""" +"""Contains SphinxError and a few subclasses.""" from typing import Any -- cgit v1.2.1