archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Activity

Docs: improve imbuf.write docstring

Browse Source 
The file path wasn't documented as being optional.
This commit is contained in:
Campbell Barton
2021-06-21 12:24:02 +10:00
parent 5f71b1edd5
commit 5df6b4004c
1 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
source/blender/python/generic/imbuf_py_api.c
View File

@@ -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;