Skip to content

Commit

Permalink
Be consistent with case for names
Browse files Browse the repository at this point in the history
  • Loading branch information
FrancescAlted committed Dec 4, 2024
1 parent 068c57d commit f64f314
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README_B2ND_FORMAT.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ b2nd Format
The b2nd format is meant for storing multidimensional datasets defined by a shape and a data type.
Both the shape and the data type follow the NumPy conventions.

It is just a `b2nd metalayer <https://github.com/Blosc/c-blosc2/blob/main/README_B2ND_METALAYER.rst>`_
on top of a Blosc2 `cframe <https://github.com/Blosc/c-blosc2/blob/main/README_CFRAME_FORMAT.rst>`_
(for contiguous storage) or `sframe <https://github.com/Blosc/c-blosc2/blob/main/README_SFRAME_FORMAT.rst>`_
It is just a `B2ND metalayer <https://github.com/Blosc/c-blosc2/blob/main/README_B2ND_METALAYER.rst>`_
on top of a Blosc2 `CFrame <https://github.com/Blosc/c-blosc2/blob/main/README_CFRAME_FORMAT.rst>`_
(for contiguous storage) or `SFrame <https://github.com/Blosc/c-blosc2/blob/main/README_SFRAME_FORMAT.rst>`_
(for sparse storage).
2 changes: 1 addition & 1 deletion README_B2ND_METALAYER.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
b2nd Metalayer Format
=====================

This is a `metalayer <https://www.blosc.org/posts/blosc-metalayers/>`_ on top of a Blosc2 container that is meant
This is a `metalayer <https://www.blosc.org/posts/blosc-metalayers/>`_ on top of a Blosc2 CFrame that is meant
for storing multidimensional information.

Specifically, this metalayer is named 'b2nd' and follows this format::
Expand Down
2 changes: 1 addition & 1 deletion README_CFRAME_FORMAT.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Blosc2 Contiguous Frame Format
==============================

Blosc (as of version 2.0.0) has a contiguous frame format (cframe for short) that allows for the storage of
Blosc (as of version 2.0.0) has a Contiguous Frame format (CFrame for short) that allows for the storage of
different `Blosc data chunks <https://github.com/Blosc/c-blosc2/blob/main/README_CHUNKS_FORMAT.rst>`_ contiguously,
either in-memory or on-disk.

Expand Down
4 changes: 2 additions & 2 deletions README_EXTENSION_FILENAMES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ Extensions for Blosc2 Filenames

Blosc2 has some recommendations for different file extensions for different purposes. Here is a list of the currently supported ones:

- `.b2frame` (but also `.b2f` or `.b2`) (Blosc2 frame): this is the main extension for storing `Blosc2 contiguous frames <https://github.com/Blosc/c-blosc2/blob/main/README_CFRAME_FORMAT.rst>`_.
- `.b2frame` (but also `.b2f` or `.b2`) (Blosc2 Frame): this is the main extension for storing `Blosc2 Contiguous Frames <https://github.com/Blosc/c-blosc2/blob/main/README_CFRAME_FORMAT.rst>`_.

- `.b2nd` (Blosc2 N-Dimensional): this is just a contiguous frame file with `a metalayer for storing n-dimensional information <https://github.com/Blosc/c-blosc2/blob/main/README_B2ND_METALAYER.rst>`_ like shape, chunkshape, blockshape and dtype.
- `.b2nd` (Blosc2 N-Dim): this is just a contiguous frame file with `a metalayer for storing n-dimensional information <https://github.com/Blosc/c-blosc2/blob/main/README_B2ND_METALAYER.rst>`_ like shape, chunkshape, blockshape and dtype.

0 comments on commit f64f314

Please sign in to comment.