Skip to content

Commit

Permalink
Documentation: Cleaned up documentation links.
Browse files Browse the repository at this point in the history
  • Loading branch information
CSSFrancis committed Nov 13, 2023
1 parent 15cb506 commit 10a9d74
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/user_guide/supported_formats/mrc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ object.

This will automatically set the navigation shape based on the ``Scan - Size X`` and = 256
``Scan - Size Y`` as well as the ``Scan - Repeats`` and ``Scan - Point Repeats``
parameters in the metadata file. The navigation shape can be overridden
parameters in the metadata file. The navigation shape can be overridden
by passing the ``navigation_shape`` argument to the ``file_reader`` function.


Expand Down
4 changes: 0 additions & 4 deletions rsciio/mrc/_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -269,9 +269,6 @@ def file_reader(
metadata_file : str
The filename of the metadata file.
Returns
-------
%s
"""

if metadata_file is not None:
Expand Down Expand Up @@ -457,5 +454,4 @@ def file_reader(
NAVIGATION_SHAPE,
DISTRIBUTED_DOC,
CHUNKS_DOC,
RETURNS_DOC,
)
2 changes: 1 addition & 1 deletion upcoming_changes/162.new.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Added the :py:func:`~.utils.distributed.memmap_distributed` function for loading a memmap file
Added the :py:func:`~rsciio.utils.distributed.memmap_distributed` function for loading a memmap file
from multiple processes.

Added the arguments ``distributed`` and ``metadata_file`` to the .mrc file reader for loading metadata
Expand Down

0 comments on commit 10a9d74

Please sign in to comment.