From cd1c31ff6cdb37dcfd4388d63f539d784918a24b Mon Sep 17 00:00:00 2001 From: Nathan Williis Date: Mon, 2 Sep 2024 17:13:48 +0100 Subject: [PATCH 1/2] Docs: reorder Sphinx extensions. Napoleon must precede autodoc or it will trigger superfluous warnings about indentation. --- Doc/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/source/conf.py b/Doc/source/conf.py index cee66549b..4976bd813 100644 --- a/Doc/source/conf.py +++ b/Doc/source/conf.py @@ -31,9 +31,9 @@ needs_sphinx = "1.3" # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + "sphinx.ext.napoleon", "sphinx.ext.autodoc", "sphinx.ext.viewcode", - "sphinx.ext.napoleon", "sphinx.ext.coverage", "sphinx.ext.autosectionlabel", ] From c19b1c51480d3e12b7f11a9c586c842f4cb3a26c Mon Sep 17 00:00:00 2001 From: Nathan Williis Date: Mon, 2 Sep 2024 17:18:41 +0100 Subject: [PATCH 2/2] Docs: move module docstrings to first line of file, as per PEP 257. --- Lib/fontTools/designspaceLib/__init__.py | 11 +++--- Lib/fontTools/ufoLib/__init__.py | 46 ++++++++++++------------ 2 files changed, 29 insertions(+), 28 deletions(-) diff --git a/Lib/fontTools/designspaceLib/__init__.py b/Lib/fontTools/designspaceLib/__init__.py index 342f1decd..0a1e782f5 100644 --- a/Lib/fontTools/designspaceLib/__init__.py +++ b/Lib/fontTools/designspaceLib/__init__.py @@ -1,3 +1,9 @@ +""" + designSpaceDocument + + - Read and write designspace files +""" + from __future__ import annotations import collections @@ -15,11 +21,6 @@ from fontTools.misc import plistlib from fontTools.misc.loggingTools import LogMixin from fontTools.misc.textTools import tobytes, tostr -""" - designSpaceDocument - - - read and write designspace files -""" __all__ = [ "AxisDescriptor", diff --git a/Lib/fontTools/ufoLib/__init__.py b/Lib/fontTools/ufoLib/__init__.py index c2d2b0b26..a014c9317 100755 --- a/Lib/fontTools/ufoLib/__init__.py +++ b/Lib/fontTools/ufoLib/__init__.py @@ -1,26 +1,3 @@ -import os -from copy import deepcopy -from os import fsdecode -import logging -import zipfile -import enum -from collections import OrderedDict -import fs -import fs.base -import fs.subfs -import fs.errors -import fs.copy -import fs.osfs -import fs.zipfs -import fs.tempfs -import fs.tools -from fontTools.misc import plistlib -from fontTools.ufoLib.validators import * -from fontTools.ufoLib.filenames import userNameToFileName -from fontTools.ufoLib.converters import convertUFO1OrUFO2KerningToUFO3Kerning -from fontTools.ufoLib.errors import UFOLibError -from fontTools.ufoLib.utils import numberTypes, _VersionTupleEnumMixin - """ A library for importing .ufo files and their descendants. Refer to http://unifiedfontobject.com for the UFO specification. @@ -51,6 +28,29 @@ fontinfo.plist values between the possible format versions. convertFontInfoValueForAttributeFromVersion3ToVersion2 """ +import os +from copy import deepcopy +from os import fsdecode +import logging +import zipfile +import enum +from collections import OrderedDict +import fs +import fs.base +import fs.subfs +import fs.errors +import fs.copy +import fs.osfs +import fs.zipfs +import fs.tempfs +import fs.tools +from fontTools.misc import plistlib +from fontTools.ufoLib.validators import * +from fontTools.ufoLib.filenames import userNameToFileName +from fontTools.ufoLib.converters import convertUFO1OrUFO2KerningToUFO3Kerning +from fontTools.ufoLib.errors import UFOLibError +from fontTools.ufoLib.utils import numberTypes, _VersionTupleEnumMixin + __all__ = [ "makeUFOPath", "UFOLibError",