DOC: update docstrings

Medical-Image-Analysis-Laboratory · Nov 4, 2020 · 3a15e99 · 3a15e99
1 parent e515bff
commit 3a15e99
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 12 deletions.
diff --git a/pymialsrtk/info.py b/pymialsrtk/info.py
@@ -1,4 +1,4 @@
-""" This file contains cmp package information """
+"""This file contains cmp package information"""
 
 _version_major = 2
 _version_minor = 0
@@ -19,7 +19,7 @@
 __current_year__ = '2020'
 
 __author__ = 'The MIAL Super-Resolution ToolKit developers'
-__copyright__ = 'Copyright 2017-{}, Medical Image Analysis Laboratory (MIAL), Lausanne'.format(__current_year__)
+__copyright__ = 'Copyright 2016-{}, Medical Image Analysis Laboratory (MIAL), Lausanne'.format(__current_year__)
 __credits__ = ('Contributors: please check the ``.zenodo.json`` file at the top-level folder'
                'of the repository')
 __license__ = '3-clause BSD'

diff --git a/pymialsrtk/interfaces/postprocess.py b/pymialsrtk/interfaces/postprocess.py
@@ -2,7 +2,11 @@
 #
 #  This software is distributed under the open-source license Modified BSD.
 
-""" PyMIALSRTK postprocessing functions encompassing a High Resolution mask refinement and an N4 global bias field correction."""
+"""PyMIALSRTK postprocessing functions
+
+It encompasses a High Resolution mask refinement and an N4 global bias field correction.
+
+"""
 
 import os
 

diff --git a/pymialsrtk/interfaces/preprocess.py b/pymialsrtk/interfaces/preprocess.py
@@ -2,9 +2,9 @@
 #
 #  This software is distributed under the open-source license Modified BSD.
 
-"""
+"""PyMIALSRTK preprocessing functions
 
-PyMIALSRTK preprocessing functions including BTK Non-local-mean denoising, slice intensity correction
+It includes BTK Non-local-mean denoising, slice intensity correction
 slice N4 bias field correction, slice-by-slice correct bias field, intensity standardization,
 histogram normalization and both manual or deep learning based automatic brain extraction.
 

diff --git a/pymialsrtk/interfaces/reconstruction.py b/pymialsrtk/interfaces/reconstruction.py
@@ -2,8 +2,7 @@
 #
 #  This software is distributed under the open-source license Modified BSD.
 
-"""PyMIALSRTK preprocessing functions
-"""
+"""PyMIALSRTK reconstruction functions"""
 
 import os
 

diff --git a/pymialsrtk/parser.py b/pymialsrtk/parser.py
@@ -1,9 +1,8 @@
-# Copyright © 2016-2019 Medical Image Analysis Laboratory, University Hospital Center and University of Lausanne (UNIL-CHUV), Switzerland
+# Copyright © 2016-2020 Medical Image Analysis Laboratory, University Hospital Center and University of Lausanne (UNIL-CHUV), Switzerland
 #
 #  This software is distributed under the open-source license Modified BSD.
 
-""" MIALSRTK BIDS App Commandline Parser
-"""
+"""MIALSRTK BIDS App Commandline Parser"""
 
 from pymialsrtk.info import __version__
 from pymialsrtk.info import __release_date__

diff --git a/pymialsrtk/pipelines/anatomical/srr.py b/pymialsrtk/pipelines/anatomical/srr.py
@@ -1,5 +1,8 @@
-#!/usr/bin/env python
-# coding: utf-8
+# Copyright © 2016-2020 Medical Image Analysis Laboratory, University Hospital Center and University of Lausanne (UNIL-CHUV), Switzerland
+#
+#  This software is distributed under the open-source license Modified BSD.
+
+"""Module for the super-resolution reconstruction pipeline"""
 
 import os