Merge pull request #1200 from ZviBaratz/doc/docstrings

DOC: Standardize module-level docstrings format

Author: effigies

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
@@ -100,7 +99,7 @@ def apply_affine(aff, pts, inplace=False):
 
 
 def to_matvec(transform):
-    """Split a transform into its matrix and vector components.
+    """Split a transform into its matrix and vector components
 
     The transformation must be represented in homogeneous coordinates and is
     split into its rotation matrix and translation vector components.
@@ -312,8 +311,7 @@ def voxel_sizes(affine):
 
 
 def obliquity(affine):
-    r"""
-    Estimate the *obliquity* an affine's axes represent.
+    r"""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/arraywriters.py

@@ -28,7 +28,6 @@ def __init__(self, array, out_dtype=None)
 something else to make sense of conversions between float and int, or between
 larger ints and smaller.
 """
-
 import numpy as np
 
 from .casting import (

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/ecat.py

@@ -42,7 +42,6 @@
 GPL and some of the header files are adapted from CTI files (called CTI code
 below).  It's not clear what the licenses are for these files.
 """
-
 import warnings
 from numbers import Integral
 

nibabel/environment.py

@@ -1,9 +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/eulerangles.py

@@ -82,7 +82,6 @@
 ``y``, followed by rotation around ``x``, is known (confusingly) as
 "xyz", pitch-roll-yaw, Cardan angles, or Tait-Bryan angles.
 """
-
 import math
 from functools import reduce