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):