Commit 6e9f46fe authored by André Anjos's avatar André Anjos 💬
Browse files

More doc fixes

parent fcec78af
Pipeline #4149 failed with stage
in 7 minutes and 10 seconds
...@@ -22,7 +22,7 @@ def open_file(filename, mode='rt'): ...@@ -22,7 +22,7 @@ def open_file(filename, mode='rt'):
Parameters: Parameters:
filename (:py:class:`str`, file object): The name of the score file to filename (:py:class:`str`, ``file-like``): The name of the score file to
open, or a file-like object open for reading. If a file name is given, open, or a file-like object open for reading. If a file name is given,
the according file might be a raw text file or a (compressed) tar file the according file might be a raw text file or a (compressed) tar file
containing a raw text file. containing a raw text file.
...@@ -31,7 +31,7 @@ def open_file(filename, mode='rt'): ...@@ -31,7 +31,7 @@ def open_file(filename, mode='rt'):
Returns: Returns:
file: A read-only file-like object as it would be returned by ``file-like``: A read-only file-like object as it would be returned by
:py:func:`open`. :py:func:`open`.
""" """
...@@ -74,7 +74,7 @@ def four_column(filename): ...@@ -74,7 +74,7 @@ def four_column(filename):
Parameters: Parameters:
filename (:py:class:`str`, :py:class:`File`): The file object that will be filename (:py:class:`str`, ``file-like``): The file object that will be
opened with :py:func:`open_file` containing the scores. opened with :py:func:`open_file` containing the scores.
...@@ -119,7 +119,7 @@ def split_four_column(filename): ...@@ -119,7 +119,7 @@ def split_four_column(filename):
Parameters: Parameters:
filename (:py:class:`str`, :py:class:`File`): The file object that will be filename (:py:class:`str`, ``file-like``): The file object that will be
opened with :py:func:`open_file` containing the scores. opened with :py:func:`open_file` containing the scores.
...@@ -155,7 +155,7 @@ def cmc_four_column(filename): ...@@ -155,7 +155,7 @@ def cmc_four_column(filename):
Parameters: Parameters:
filename (:py:class:`str`, :py:class:`File`): The file object that will be filename (:py:class:`str`, ``file-like``): The file object that will be
opened with :py:func:`open_file` containing the scores. opened with :py:func:`open_file` containing the scores.
...@@ -201,7 +201,7 @@ def five_column(filename): ...@@ -201,7 +201,7 @@ def five_column(filename):
Parameters: Parameters:
filename (:py:class:`str`, :py:class:`File`): The file object that will be filename (:py:class:`str`, ``file-like``): The file object that will be
opened with :py:func:`open_file` containing the scores. opened with :py:func:`open_file` containing the scores.
...@@ -248,7 +248,7 @@ def split_five_column(filename): ...@@ -248,7 +248,7 @@ def split_five_column(filename):
Parameters: Parameters:
filename (:py:class:`str`, :py:class:`File`): The file object that will be filename (:py:class:`str`, ``file-like``): The file object that will be
opened with :py:func:`open_file` containing the scores. opened with :py:func:`open_file` containing the scores.
...@@ -284,7 +284,7 @@ def cmc_five_column(filename): ...@@ -284,7 +284,7 @@ def cmc_five_column(filename):
Parameters: Parameters:
filename (:py:class:`str`, :py:class:`File`): The file object that will be filename (:py:class:`str`, ``file-like``): The file object that will be
opened with :py:func:`open_file` containing the scores. opened with :py:func:`open_file` containing the scores.
...@@ -317,7 +317,7 @@ def load_score(filename, ncolumns=None): ...@@ -317,7 +317,7 @@ def load_score(filename, ncolumns=None):
Parameters: Parameters:
filename (:py:class:`str`, :py:class:`File`): The file object that will be filename (:py:class:`str`, ``file-like``): The file object that will be
opened with :py:func:`open_file` containing the scores. opened with :py:func:`open_file` containing the scores.
ncolumns (:py:class:`int`, optional): 4, 5 or None (the default), ncolumns (:py:class:`int`, optional): 4, 5 or None (the default),
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment