DOC: Homogenized module-level docstring formatting

Author: ZviBaratz

nibabel/affines.py

@@ -1,7 +1,6 @@
 # emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: nil -*-
 # vi: set ft=python sts=4 ts=4 sw=4 et:
-"""Utility routines for working with points and affine transforms
-"""
+"""Utility routines for working with points and affine transforms"""
 from functools import reduce
 
 import numpy as np
@@ -313,7 +312,7 @@ def voxel_sizes(affine):
 
 def obliquity(affine):
     r"""
-    Estimate the *obliquity* an affine's axes represent.
+    Estimate the *obliquity* an affine's axes represent
 
     The term *obliquity* is defined here as the rotation of those axes with
     respect to the cardinal axes.

nibabel/brikhead.py

@@ -6,8 +6,7 @@
 #   copyright and license terms.
 #
 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
-"""
-Class for reading AFNI BRIK/HEAD datasets
+"""Class for reading AFNI BRIK/HEAD datasets
 
 See https://afni.nimh.nih.gov/pub/dist/doc/program_help/README.attributes.html
 for information on what is required to have a valid BRIK/HEAD dataset.

nibabel/data.py

@@ -1,8 +1,6 @@
 # emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: nil -*-
 # vi: set ft=python sts=4 ts=4 sw=4 et:
-"""
-Utilities to find files from NIPY data packages
-"""
+"""Utilities to find files from NIPY data packages"""
 import configparser
 import glob
 import os

nibabel/deprecated.py

@@ -1,5 +1,4 @@
-"""Module to help with deprecating objects and classes
-"""
+"""Module to help with deprecating objects and classes"""
 from __future__ import annotations
 
 import typing as ty

nibabel/deprecator.py

@@ -1,5 +1,4 @@
-"""Class for recording and reporting deprecations
-"""
+"""Class for recording and reporting deprecations"""
 from __future__ import annotations
 
 import functools

nibabel/dft.py

@@ -7,8 +7,7 @@
 #
 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
 # Copyright (C) 2011 Christian Haselgrove
-"""DICOM filesystem tools
-"""
+"""DICOM filesystem tools"""
 
 
 import contextlib

nibabel/environment.py

@@ -1,8 +1,6 @@
 # emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: nil -*-
 # vi: set ft=python sts=4 ts=4 sw=4 et:
-"""
-Settings from the system environment relevant to NIPY
-"""
+"""Settings from the system environment relevant to NIPY"""
 
 import os
 from os.path import join as pjoin

nibabel/filebasedimages.py

@@ -6,7 +6,7 @@
 #   copyright and license terms.
 #
 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
-"""Common interface for any image format--volume or surface, binary or xml."""
+"""Common interface for any image format--volume or surface, binary or xml"""
 from __future__ import annotations
 
 import io

nibabel/fileslice.py

@@ -1,5 +1,4 @@
-"""Utilities for getting array slices out of file-like objects
-"""
+"""Utilities for getting array slices out of file-like objects"""
 
 import operator
 from functools import reduce

nibabel/fileutils.py

@@ -6,8 +6,7 @@
 #   copyright and license terms.
 #
 # ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
-"""Utilities for reading and writing to binary file formats
-"""
+"""Utilities for reading and writing to binary file formats"""
 
 
 def read_zt_byte_strings(fobj, n_strings=1, bufsize=1024):

nibabel/imagestats.py

@@ -6,9 +6,7 @@
 #   copyright and license terms.
 #
 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
-"""
-Functions for computing image statistics
-"""
+"""Functions for computing image statistics"""
 
 import numpy as np
 

nibabel/mriutils.py

@@ -6,9 +6,7 @@
 #   copyright and license terms.
 #
 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
-"""
-Utilities for calculations related to MRI
-"""
+"""Utilities for calculations related to MRI"""
 
 __all__ = ['calculate_dwell_time']
 

nibabel/onetime.py

@@ -1,5 +1,4 @@
-"""
-Descriptor support for NIPY.
+"""Descriptor support for NIPY
 
 Utilities to support special Python descriptors [1,2], in particular the use of
 a useful pattern for properties we call 'one time properties'.  These are

nibabel/openers.py

@@ -6,8 +6,7 @@
 #   copyright and license terms.
 #
 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
-"""Context manager openers for various fileobject types
-"""
+"""Context manager openers for various fileobject types"""
 
 import gzip
 import warnings

nibabel/parrec.py

@@ -8,7 +8,7 @@
 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
 # Disable line length checking for PAR fragments in module docstring
 # flake8: noqa E501
-"""Read images in PAR/REC format.
+"""Read images in PAR/REC format
 
 This is yet another MRI image format generated by Philips scanners. It is an
 ASCII header (PAR) plus a binary blob (REC).

nibabel/processing.py

@@ -6,13 +6,15 @@
 #   copyright and license terms.
 #
 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
-"""Image processing functions for:
+"""Image processing functions
 
-* smoothing
-* resampling
-* converting sd to and from FWHM
+Image processing functions for:
 
-Smoothing and resampling routines need scipy
+    * smoothing
+    * resampling
+    * converting SD to and from FWHM
+
+Smoothing and resampling routines need scipy.
 """
 
 import numpy as np

nibabel/quaternions.py

@@ -7,7 +7,7 @@
 #
 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
 """
-Functions to operate on, or return, quaternions.
+Functions to operate on, or return, quaternions
 
 The module also includes functions for the closely related angle, axis
 pair as a specification for rotation.

nibabel/tmpdirs.py

@@ -6,8 +6,7 @@
 #   copyright and license terms.
 #
 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
-"""Contexts for *with* statement providing temporary directories
-"""
+"""Contexts for *with* statement providing temporary directories"""
 import os
 import tempfile
 from contextlib import contextmanager

nibabel/tripwire.py

@@ -1,5 +1,4 @@
-"""Class to raise error for missing modules or other misfortunes
-"""
+"""Class to raise error for missing modules or other misfortunes"""
 from typing import Any
 
 

nibabel/viewers.py

@@ -14,7 +14,7 @@
 
 
 class OrthoSlicer3D:
-    """Orthogonal-plane slice viewer.
+    """Orthogonal-plane slice viewer
 
     OrthoSlicer3d expects 3- or 4-dimensional array data.  It treats
     4D data as a sequence of 3D spatial volumes, where a slice over the final

nibabel/xmlutils.py

@@ -6,9 +6,7 @@
 #   copyright and license terms.
 #
 ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ### ##
-"""
-Thin layer around xml.etree.ElementTree, to abstract nibabel xml support.
-"""
+"""Thin layer around xml.etree.ElementTree, to abstract nibabel xml support"""
 
 from io import BytesIO
 from xml.etree.ElementTree import Element, SubElement, tostring  # noqa