Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2021-06-21 05:24:02 +0300
committerCampbell Barton <ideasman42@gmail.com>2021-06-21 05:25:36 +0300
commit5df6b4004c9b03574dcb8056630d88ad5f1d1a0b (patch)
tree4e6c07a704f7f9d6f25d3dc96284fe00acfafc64 /source/blender/python
parent5f71b1edd5bfe71b95f668548c6f9b7cfcf03a17 (diff)
Docs: improve imbuf.write docstring
The file path wasn't documented as being optional.
Diffstat (limited to 'source/blender/python')
-rw-r--r--source/blender/python/generic/imbuf_py_api.c19
1 files changed, 10 insertions, 9 deletions
diff --git a/source/blender/python/generic/imbuf_py_api.c b/source/blender/python/generic/imbuf_py_api.c
index 53e22314ec4..793b980295c 100644
--- a/source/blender/python/generic/imbuf_py_api.c
+++ b/source/blender/python/generic/imbuf_py_api.c
@@ -495,15 +495,16 @@ static PyObject *M_imbuf_load(PyObject *UNUSED(self), PyObject *args, PyObject *
return Py_ImBuf_CreatePyObject(ibuf);
}
-PyDoc_STRVAR(M_imbuf_write_doc,
- ".. function:: write(image, filepath)\n"
- "\n"
- " Write an image.\n"
- "\n"
- " :arg image: the image to write.\n"
- " :type image: :class:`ImBuf`\n"
- " :arg filepath: the filepath of the image.\n"
- " :type filepath: string\n");
+PyDoc_STRVAR(
+ M_imbuf_write_doc,
+ ".. function:: write(image, filepath=image.filepath)\n"
+ "\n"
+ " Write an image.\n"
+ "\n"
+ " :arg image: the image to write.\n"
+ " :type image: :class:`ImBuf`\n"
+ " :arg filepath: Optional filepath of the image (fallback to the images file path).\n"
+ " :type filepath: string\n");
static PyObject *M_imbuf_write(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
{
Py_ImBuf *py_imb;