Commit 145429d6 authored by Manuel Günther's avatar Manuel Günther
Browse files

Small documentation correction [skip ci]

parent 414a84f8
...@@ -104,7 +104,7 @@ def merge(filenames): ...@@ -104,7 +104,7 @@ def merge(filenames):
"""merge(filenames) -> files """merge(filenames) -> files
Converts an iterable of filenames into an iterable over read-only Converts an iterable of filenames into an iterable over read-only
:py:class`bob.io.base.File`'s. :py:class:`bob.io.base.File`'s.
**Parameters:** **Parameters:**
......
...@@ -46,7 +46,7 @@ static auto s_file = bob::extension::ClassDoc( ...@@ -46,7 +46,7 @@ static auto s_file = bob::extension::ClassDoc(
) )
.add_prototype("filename, [mode], [pretend_extension]", "") .add_prototype("filename, [mode], [pretend_extension]", "")
.add_parameter("filename", "str", "The file path to the file you want to open") .add_parameter("filename", "str", "The file path to the file you want to open")
.add_parameter("mode", "str, one of ('r', 'w', 'a')", "[Default: ``'r'``] A single character indicating if you'd like to ``'r'``ead, ``'w'``rite or ``'a'``ppend into the file; if you choose ``'w'`` and the file already exists, it will be truncated") .add_parameter("mode", "one of ('r', 'w', 'a')", "[Default: ``'r'``] A single character indicating if you'd like to ``'r'``\\ ead, ``'w'``\\ rite or ``'a'``\\ ppend into the file; if you choose ``'w'`` and the file already exists, it will be truncated")
.add_parameter("pretend_extension", "str", "[optional] An extension to use; see :py:func:`bob.io.base.extensions` for a list of (currently) supported extensions") .add_parameter("pretend_extension", "str", "[optional] An extension to use; see :py:func:`bob.io.base.extensions` for a list of (currently) supported extensions")
); );
/* How to create a new PyBobIoFileObject */ /* How to create a new PyBobIoFileObject */
...@@ -396,7 +396,7 @@ static auto s_write = bob::extension::FunctionDoc( ...@@ -396,7 +396,7 @@ static auto s_write = bob::extension::FunctionDoc(
true true
) )
.add_prototype("data") .add_prototype("data")
.add_parameter("data", "array_like", "The array to be written into the file; it can be a :py:class:`numpy.array`, a :py:class:`bob.blitz.array` or any other object which can be converted to either of them") .add_parameter("data", "array_like", "The array to be written into the file; it can be a :py:class:`numpy.ndarray`, a :py:class:`bob.blitz.array` or any other object which can be converted to either of them")
; ;
static PyObject* PyBobIoFile_write(PyBobIoFileObject* self, PyObject *args, PyObject* kwds) { static PyObject* PyBobIoFile_write(PyBobIoFileObject* self, PyObject *args, PyObject* kwds) {
BOB_TRY BOB_TRY
...@@ -424,7 +424,7 @@ static auto s_append = bob::extension::FunctionDoc( ...@@ -424,7 +424,7 @@ static auto s_append = bob::extension::FunctionDoc(
true true
) )
.add_prototype("data", "position") .add_prototype("data", "position")
.add_parameter("data", "array_like", "The array to be written into the file; it can be a :py:class:`numpy.array`, a :py:class:`bob.blitz.array` or any other object which can be converted to either of them") .add_parameter("data", "array_like", "The array to be written into the file; it can be a :py:class:`numpy.ndarray`, a :py:class:`bob.blitz.array` or any other object which can be converted to either of them")
.add_return("position", "int", "The current position of the newly written data") .add_return("position", "int", "The current position of the newly written data")
; ;
static PyObject* PyBobIoFile_append(PyBobIoFileObject* self, PyObject *args, PyObject* kwds) { static PyObject* PyBobIoFile_append(PyBobIoFileObject* self, PyObject *args, PyObject* kwds) {
......
Supports Markdown
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