Add a new section on recommended extensions for blosc2 files

Blosc · Dec 2, 2024 · 5c36318 · 5c36318
1 parent 35b82e6
commit 5c36318
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 9 deletions.
diff --git a/README_B2ND_FORMAT.rst b/README_B2ND_FORMAT.rst
@@ -1,4 +1,4 @@
-b2nd format
+b2nd Format
 ===========
 
 The b2nd format is just a `b2nd metalayer <https://github.com/Blosc/c-blosc2/blob/main/README_B2ND_METALAYER.rst>`_

diff --git a/README_B2ND_METALAYER.rst b/README_B2ND_METALAYER.rst
@@ -1,5 +1,5 @@
-b2nd metalayer
-==============
+b2nd Metalayer Format
+=====================
 
 This is a `metalayer <https://www.blosc.org/posts/blosc-metalayers/>`_ on top of a Blosc2 container that is meant
 for storing multidimensional information.

diff --git a/README_CHUNK_FORMAT.rst b/README_CHUNK_FORMAT.rst
@@ -1,5 +1,5 @@
-Blosc Chunk Format
-==================
+Blosc/Blosc2 Chunk Format
+=========================
 
 A regular chunk is composed of a header and a blocks section::
 

diff --git a/README_EXTENSION_FILENAMES.rst b/README_EXTENSION_FILENAMES.rst
@@ -1,8 +1,8 @@
-Extensions for Blosc2 filenames
+Extensions for Blosc2 Filenames
 ===============================
 
-Blosc2 has different file extensions for different purposes.  Here is a list of the currently supported ones:
+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>`_.
 
-- `.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-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.
diff --git a/README_FORMAT.rst b/README_FORMAT.rst
@@ -1,4 +1,4 @@
-Blosc2 format
+Blosc2 Format
 =============
 
 The Blosc2 format is a specification for storing compressed data in a way that is simple to read and parse,
@@ -13,3 +13,7 @@ Here there is a list of the different parts of the format, from the highest leve
 - `sframe format <https://github.com/Blosc/c-blosc2/blob/main/README_SFRAME_FORMAT.rst>`_
 - `cframe format <https://github.com/Blosc/c-blosc2/blob/main/README_CFRAME_FORMAT.rst>`_
 - `chunk format <https://github.com/Blosc/c-blosc2/blob/main/README_CHUNK_FORMAT.rst>`_
+
+And here the recommended extension file names for the different parts of the format:
+
+- `Blosc2 extension file names <https://github.com/Blosc/c-blosc2/blob/main/README_EXTENSION_FILENAMES.rst>`_
diff --git a/doc/format/extension_filenames.rst b/doc/format/extension_filenames.rst
@@ -0,0 +1 @@
+.. include:: ../../README_EXTENSION_FILENAMES.rst
diff --git a/doc/format/index.rst b/doc/format/index.rst
@@ -11,6 +11,7 @@ Blosc2 Format
    sframe_format
    cframe_format
    chunk_format
+   extension_filenames
 
 The Blosc2 format is a specification for storing compressed data in a way that is simple to read and parse, and that allows for fast random access to the compressed data. The format is designed to be used with the Blosc2 library, but it is not tied to it, and can be used independently. Emphasis has been put on simplicity and robustness, so that the format can be used in a wide range of applications.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		.. include:: ../../README_EXTENSION_FILENAMES.rst