Skip to content

Commit a605005

Browse files
committed
DOC: move io implementation doc to old stuff
IO implementation not useful now; move to old stuff and remove 'refactoring' directory and index.
1 parent 3ec30a9 commit a605005

File tree

3 files changed

+21
-16
lines changed

3 files changed

+21
-16
lines changed

doc/source/devel/devdiscuss.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,4 @@ to the current codebase, and are only for discussion of future directions.
2020
:maxdepth: 2
2121

2222
usecases/index
23-
refactoring/index
2423
data_pkg_design

doc/source/devel/refactoring/index.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

doc/source/devel/refactoring/ioimplementation.rst renamed to doc/source/old/ioimplementation.rst

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,26 @@
11
.. -*- mode: rst -*-
22
3-
====================================================
4-
Relationship between images and io implementations
5-
====================================================
3+
##################################################
4+
Relationship between images and io implementations
5+
##################################################
66

7+
********************
8+
Summary and sign-off
9+
********************
10+
11+
These were some meditations about splitting the image into two API parts.
12+
13+
The first part would be the lower level IO implementation. This part is
14+
rather like a fusion of the :class:`.Header` and :class:`.ArrayProxy` objects
15+
in current nibabel. It takes care of lower level details like i/o data dtype,
16+
shape, offset, and it might help with slicing to get the data. On top of that
17+
would be a high level interface implementing ``load``, ``save``, ``filename``,
18+
``data``. The top-level image also had the novel idea of a ``mode`` parameter
19+
which, if ``'r'``, would raise an error on attempting to ``save``.
20+
21+
******
722
Images
8-
======
23+
******
924

1025
An image houses the association of the:
1126

@@ -29,8 +44,9 @@ images to disk.
2944
The user does not see the io implementation unless they ask to. In
3045
standard use of images they will not need to do this.
3146

47+
******************
3248
IO implementations
33-
==================
49+
******************
3450

3551
By use case.
3652

0 commit comments

Comments
 (0)