From 057079008c77da9e1de851fec93faa132a90a01a Mon Sep 17 00:00:00 2001 From: Synchon Mandal Date: Wed, 17 Apr 2024 11:56:22 +0200 Subject: [PATCH 1/2] docs: improve docstrings for __init__.py wherever necessary --- docs/api/nilearn.rst | 2 -- docs/api/onthefly.rst | 2 -- junifer/api/__init__.py | 2 +- junifer/api/queue_context/__init__.py | 2 +- junifer/configs/__init__.py | 2 +- junifer/configs/juseless/__init__.py | 2 +- junifer/configs/juseless/datagrabbers/__init__.py | 2 +- junifer/data/__init__.py | 2 +- junifer/data/coordinates.py | 2 +- junifer/data/masks.py | 2 +- junifer/data/parcellations.py | 2 +- junifer/data/template_spaces.py | 2 +- junifer/datagrabber/__init__.py | 2 +- junifer/datareader/__init__.py | 2 +- junifer/external/__init__.py | 2 +- junifer/external/nilearn/__init__.py | 2 +- junifer/markers/__init__.py | 2 +- junifer/onthefly/__init__.py | 2 +- junifer/pipeline/__init__.py | 2 +- junifer/preprocess/__init__.py | 2 +- junifer/stats.py | 2 +- junifer/storage/__init__.py | 2 +- junifer/testing/__init__.py | 2 +- junifer/testing/datagrabbers.py | 2 +- junifer/utils/__init__.py | 2 +- 25 files changed, 23 insertions(+), 27 deletions(-) diff --git a/docs/api/nilearn.rst b/docs/api/nilearn.rst index 100ef9fb5..d470a15be 100644 --- a/docs/api/nilearn.rst +++ b/docs/api/nilearn.rst @@ -1,8 +1,6 @@ Nilearn ======= -This package provides re-implementations of some of the functions in `nilearn`_. - .. automodule:: junifer.external.nilearn :members: :imported-members: diff --git a/docs/api/onthefly.rst b/docs/api/onthefly.rst index c5599e560..d4500ba1a 100644 --- a/docs/api/onthefly.rst +++ b/docs/api/onthefly.rst @@ -1,8 +1,6 @@ On-the-fly ========== -This package provides functions for quick transform operations on stored data. - .. automodule:: junifer.onthefly :members: :imported-members: diff --git a/junifer/api/__init__.py b/junifer/api/__init__.py index c9a5331fd..7031d20a6 100644 --- a/junifer/api/__init__.py +++ b/junifer/api/__init__.py @@ -1,4 +1,4 @@ -"""Provide imports for api sub-package.""" +"""Public API and CLI components.""" # Authors: Federico Raimondo # Synchon Mandal diff --git a/junifer/api/queue_context/__init__.py b/junifer/api/queue_context/__init__.py index 8e1953412..ca4ea2074 100644 --- a/junifer/api/queue_context/__init__.py +++ b/junifer/api/queue_context/__init__.py @@ -1,4 +1,4 @@ -"""Provide imports for queue context sub-package.""" +"""Context adapters for queueing.""" # Authors: Synchon Mandal # License: AGPL diff --git a/junifer/configs/__init__.py b/junifer/configs/__init__.py index 2ebbe7db6..3109f2b5b 100644 --- a/junifer/configs/__init__.py +++ b/junifer/configs/__init__.py @@ -1,4 +1,4 @@ -"""Provide imports for configs sub-package.""" +"""Custom components for specific platforms.""" # Authors: Federico Raimondo # License: AGPL diff --git a/junifer/configs/juseless/__init__.py b/junifer/configs/juseless/__init__.py index 84ff7edbe..db7014b83 100644 --- a/junifer/configs/juseless/__init__.py +++ b/junifer/configs/juseless/__init__.py @@ -1,4 +1,4 @@ -"""Provide imports for juseless sub-package.""" +"""Custom components for FZJ INM-7's beloved juseless.""" # Authors: Federico Raimondo # License: AGPL diff --git a/junifer/configs/juseless/datagrabbers/__init__.py b/junifer/configs/juseless/datagrabbers/__init__.py index e826373d6..edd5eb9d6 100644 --- a/junifer/configs/juseless/datagrabbers/__init__.py +++ b/junifer/configs/juseless/datagrabbers/__init__.py @@ -1,4 +1,4 @@ -"""Provide imports for datagrabbers sub-package.""" +"""Custom DataGrabbers for FZJ INM-7's beloved juseless.""" # Authors: Federico Raimondo # Leonard Sasse diff --git a/junifer/data/__init__.py b/junifer/data/__init__.py index 663ed1dbe..8e69bf592 100644 --- a/junifer/data/__init__.py +++ b/junifer/data/__init__.py @@ -1,4 +1,4 @@ -"""Provide imports for data sub-package.""" +"""Parcellations, coordinates and masks.""" # Authors: Federico Raimondo # Synchon Mandal diff --git a/junifer/data/coordinates.py b/junifer/data/coordinates.py index b07b42ce4..3d6c0076c 100644 --- a/junifer/data/coordinates.py +++ b/junifer/data/coordinates.py @@ -1,4 +1,4 @@ -"""Provide functions for list of coordinates.""" +"""Functions for coordinates manipulation.""" # Authors: Federico Raimondo # Synchon Mandal diff --git a/junifer/data/masks.py b/junifer/data/masks.py index a7be41ff7..e059f538f 100644 --- a/junifer/data/masks.py +++ b/junifer/data/masks.py @@ -1,4 +1,4 @@ -"""Provide functions for masks.""" +"""Functions for mask manipulation.""" # Authors: Federico Raimondo # Synchon Mandal diff --git a/junifer/data/parcellations.py b/junifer/data/parcellations.py index 4331d41be..fbd9d8fba 100644 --- a/junifer/data/parcellations.py +++ b/junifer/data/parcellations.py @@ -1,4 +1,4 @@ -"""Provide functions for parcellation.""" +"""Functions for parcellation manipulation.""" # Authors: Federico Raimondo # Vera Komeyer diff --git a/junifer/data/template_spaces.py b/junifer/data/template_spaces.py index 251854773..409d6550e 100644 --- a/junifer/data/template_spaces.py +++ b/junifer/data/template_spaces.py @@ -1,4 +1,4 @@ -"""Provide functions for template spaces.""" +"""Functions for template space manipulation.""" # Authors: Synchon Mandal # License: AGPL diff --git a/junifer/datagrabber/__init__.py b/junifer/datagrabber/__init__.py index 7986c3ea2..be95a85f9 100644 --- a/junifer/datagrabber/__init__.py +++ b/junifer/datagrabber/__init__.py @@ -1,4 +1,4 @@ -"""Provide imports for datagrabber sub-package.""" +"""DataGrabbers for datasets' data description.""" # Authors: Federico Raimondo # Leonard Sasse diff --git a/junifer/datareader/__init__.py b/junifer/datareader/__init__.py index 19212063c..5ad1c5c32 100644 --- a/junifer/datareader/__init__.py +++ b/junifer/datareader/__init__.py @@ -1,4 +1,4 @@ -"""Provide imports for datareader sub-package.""" +"""DataReaders for datasets' data loading.""" # Authors: Federico Raimondo # Leonard Sasse diff --git a/junifer/external/__init__.py b/junifer/external/__init__.py index 0d705b570..c7a5b28f1 100644 --- a/junifer/external/__init__.py +++ b/junifer/external/__init__.py @@ -1,4 +1,4 @@ -"""Provide imports for external sub-package.""" +"""External tools adapted for junifer.""" # Authors: Synchon Mandal # License: AGPL diff --git a/junifer/external/nilearn/__init__.py b/junifer/external/nilearn/__init__.py index 99a7630b6..7575c3212 100644 --- a/junifer/external/nilearn/__init__.py +++ b/junifer/external/nilearn/__init__.py @@ -1,4 +1,4 @@ -"""Provide imports for custom nilearn objects sub-package.""" +"""Custom objects adapted from nilearn.""" # Authors: Synchon Mandal # License: AGPL diff --git a/junifer/markers/__init__.py b/junifer/markers/__init__.py index d6c67d4e6..b8dbb0263 100644 --- a/junifer/markers/__init__.py +++ b/junifer/markers/__init__.py @@ -1,4 +1,4 @@ -"""Provide imports for markers sub-package.""" +"""Markers for feature extraction.""" # Authors: Federico Raimondo # Leonard Sasse diff --git a/junifer/onthefly/__init__.py b/junifer/onthefly/__init__.py index bfaff947f..183966b53 100644 --- a/junifer/onthefly/__init__.py +++ b/junifer/onthefly/__init__.py @@ -1,4 +1,4 @@ -"""Provide imports for onthefly sub-package.""" +"""Utilities for on-the-fly analyses.""" # Authors: Synchon Mandal # License: AGPL diff --git a/junifer/pipeline/__init__.py b/junifer/pipeline/__init__.py index 1ea157d60..44e521c52 100644 --- a/junifer/pipeline/__init__.py +++ b/junifer/pipeline/__init__.py @@ -1,4 +1,4 @@ -"""Provide imports for pipeline sub-package.""" +"""Pipeline components.""" # Authors: Synchon Mandal # License: AGPL diff --git a/junifer/preprocess/__init__.py b/junifer/preprocess/__init__.py index d60c6efdd..8c83b9aab 100644 --- a/junifer/preprocess/__init__.py +++ b/junifer/preprocess/__init__.py @@ -1,4 +1,4 @@ -"""Provide imports for preprocess sub-package.""" +"""Preprocessors for preprocessing data before feature extraction.""" # Authors: Federico Raimondo # Leonard Sasse diff --git a/junifer/stats.py b/junifer/stats.py index aa411f832..d87e31cb4 100644 --- a/junifer/stats.py +++ b/junifer/stats.py @@ -1,4 +1,4 @@ -"""Provide functions for statistics.""" +"""Statistical functions and helpers.""" # Authors: Federico Raimondo # Synchon Mandal diff --git a/junifer/storage/__init__.py b/junifer/storage/__init__.py index 1e756e6cc..d355c3413 100644 --- a/junifer/storage/__init__.py +++ b/junifer/storage/__init__.py @@ -1,4 +1,4 @@ -"""Provide imports for storage sub-package.""" +"""Storages for storing extracted features.""" # Authors: Federico Raimondo # Synchon Mandal diff --git a/junifer/testing/__init__.py b/junifer/testing/__init__.py index 6a4cdba70..ed232268e 100644 --- a/junifer/testing/__init__.py +++ b/junifer/testing/__init__.py @@ -1,4 +1,4 @@ -"""Provide imports for testing sub-package.""" +"""Testing components.""" # Authors: Federico Raimondo # Synchon Mandal diff --git a/junifer/testing/datagrabbers.py b/junifer/testing/datagrabbers.py index ffb744cfd..f14a11fdb 100644 --- a/junifer/testing/datagrabbers.py +++ b/junifer/testing/datagrabbers.py @@ -1,4 +1,4 @@ -"""Provide testing DataGrabbers.""" +"""Testing DataGrabbers.""" # Authors: Federico Raimondo # Synchon Mandal diff --git a/junifer/utils/__init__.py b/junifer/utils/__init__.py index 3492e76df..f63888fd7 100644 --- a/junifer/utils/__init__.py +++ b/junifer/utils/__init__.py @@ -1,4 +1,4 @@ -"""Provide imports for utils sub-package.""" +"""General utilities and helpers.""" # Authors: Federico Raimondo # Synchon Mandal -- 2.52.0 From 6dd6fd4d4db42bf1b8942f8c5c5ee8a5f68c23c6 Mon Sep 17 00:00:00 2001 From: Synchon Mandal Date: Wed, 17 Apr 2024 13:34:58 +0200 Subject: [PATCH 2/2] chore: add changelog 115.doc --- docs/changes/newsfragments/115.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/changes/newsfragments/115.doc diff --git a/docs/changes/newsfragments/115.doc b/docs/changes/newsfragments/115.doc new file mode 100644 index 000000000..e732e9196 --- /dev/null +++ b/docs/changes/newsfragments/115.doc @@ -0,0 +1 @@ +Improve sub-package level docstrings to better reflect their purposes by `Synchon Mandal`_ -- 2.52.0