From 72369c638d936a76ba58c98b4b89626f6ff28f32 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Wed, 14 Nov 2018 09:04:24 +1100 Subject: Cleanup: python doc-strings Indentation & trailing space. --- source/blender/python/gpu/gpu_py_batch.c | 32 +++++++++++++++--------------- source/blender/python/gpu/gpu_py_element.c | 10 +++++----- source/blender/python/gpu/gpu_py_shader.c | 2 +- 3 files changed, 22 insertions(+), 22 deletions(-) (limited to 'source/blender/python/gpu') diff --git a/source/blender/python/gpu/gpu_py_batch.c b/source/blender/python/gpu/gpu_py_batch.c index 77dcfad2c9f..ffbd2a17e34 100644 --- a/source/blender/python/gpu/gpu_py_batch.c +++ b/source/blender/python/gpu/gpu_py_batch.c @@ -132,14 +132,14 @@ static PyObject *bpygpu_Batch_new(PyTypeObject *UNUSED(type), PyObject *args, Py PyDoc_STRVAR(bpygpu_Batch_vertbuf_add_doc, ".. method:: vertbuf_add(buf)\n" "\n" -" Add another vertex buffer to the Batch. \n" -" It is not possible to add more vertices to the batch using this method. \n" -" Instead it can be used to add more attributes to the existing vertices. \n" -" A good use case would be when you have a separate vertex buffer for vertex positions and vertex normals. \n" -" Current a batch can have at most " STRINGIFY(GPU_BATCH_VBO_MAX_LEN) " vertex buffers. \n" +" Add another vertex buffer to the Batch.\n" +" It is not possible to add more vertices to the batch using this method.\n" +" Instead it can be used to add more attributes to the existing vertices.\n" +" A good use case would be when you have a separate vertex buffer for vertex positions and vertex normals.\n" +" Current a batch can have at most " STRINGIFY(GPU_BATCH_VBO_MAX_LEN) " vertex buffers.\n" "\n" -" :param buf: The vertex buffer that will be added to the batch. \n" -" :type buf: :class:`gpu.types.GPUVertBuf` \n" +" :param buf: The vertex buffer that will be added to the batch.\n" +" :type buf: :class:`gpu.types.GPUVertBuf`\n" ); static PyObject *bpygpu_Batch_vertbuf_add(BPyGPUBatch *self, BPyGPUVertBuf *py_buf) { @@ -176,12 +176,12 @@ static PyObject *bpygpu_Batch_vertbuf_add(BPyGPUBatch *self, BPyGPUVertBuf *py_b PyDoc_STRVAR(bpygpu_Batch_program_set_doc, ".. method:: program_set(program)\n" "\n" -" Assign a shader to this batch that will be used for drawing when not overwritten later. \n" -" Note: This method has to be called in the draw context that the batch will be drawn in. \n" -" This function does not need to be called when you always set the shader when calling `batch.draw`. \n" +" Assign a shader to this batch that will be used for drawing when not overwritten later.\n" +" Note: This method has to be called in the draw context that the batch will be drawn in.\n" +" This function does not need to be called when you always set the shader when calling `batch.draw`.\n" "\n" -" :param program: The program/shader the batch will use in future draw calls. \n" -" :type program: :class:`gpu.types.GPUShader` \n" +" :param program: The program/shader the batch will use in future draw calls.\n" +" :type program: :class:`gpu.types.GPUShader`\n" ); static PyObject *bpygpu_Batch_program_set(BPyGPUBatch *self, BPyGPUShader *py_shader) { @@ -222,10 +222,10 @@ static PyObject *bpygpu_Batch_program_set(BPyGPUBatch *self, BPyGPUShader *py_sh PyDoc_STRVAR(bpygpu_Batch_draw_doc, ".. method:: draw(program=None)\n" "\n" -" Run the drawing program with the parameters assigned to the batch. \n" +" Run the drawing program with the parameters assigned to the batch.\n" "\n" -" :param program: Program that performs the drawing operations. \n" -" If ``None`` is passed, the last program setted to this batch will run. \n" +" :param program: Program that performs the drawing operations.\n" +" If ``None`` is passed, the last program setted to this batch will run.\n" " :type program: :class:`gpu.types.GPUShader`\n" ); static PyObject *bpygpu_Batch_draw(BPyGPUBatch *self, PyObject *args) @@ -320,7 +320,7 @@ static void bpygpu_Batch_dealloc(BPyGPUBatch *self) PyDoc_STRVAR(py_gpu_batch_doc, ".. class:: GPUBatch(type, buf, elem=None)\n" "\n" -" Reusable container for drawable geometry. \n" +" Reusable container for drawable geometry.\n" "\n" " :arg type: One of these primitive types: {\n" " `POINTS`,\n" diff --git a/source/blender/python/gpu/gpu_py_element.c b/source/blender/python/gpu/gpu_py_element.c index 10990abc5e6..12027d2e2b8 100644 --- a/source/blender/python/gpu/gpu_py_element.c +++ b/source/blender/python/gpu/gpu_py_element.c @@ -198,7 +198,7 @@ static void bpygpu_IndexBuf_dealloc(BPyGPUIndexBuf *self) PyDoc_STRVAR(py_gpu_element_doc, ".. class:: GPUIndexBuf(type, seq)\n" "\n" -" Contains an index buffer. \n" +" Contains an index buffer.\n" "\n" " :param type: One of these primitive types: {\n" " `POINTS`,\n" @@ -206,10 +206,10 @@ PyDoc_STRVAR(py_gpu_element_doc, " `TRIS`,\n" " `LINE_STRIP_ADJ` }\n" " :type type: `str`\n" -" :param seq: Indices this index buffer will contain. \n" -" Whether a 1D or 2D sequence is required depends on the type. \n" -" Optionally the sequence can support the buffer protocol. \n" -" :type seq: 1D or 2D sequence \n" +" :param seq: Indices this index buffer will contain.\n" +" Whether a 1D or 2D sequence is required depends on the type.\n" +" Optionally the sequence can support the buffer protocol.\n" +" :type seq: 1D or 2D sequence\n" ); PyTypeObject BPyGPUIndexBuf_Type = { PyVarObject_HEAD_INIT(NULL, 0) diff --git a/source/blender/python/gpu/gpu_py_shader.c b/source/blender/python/gpu/gpu_py_shader.c index 19d6c8070f8..46acf22d7e2 100644 --- a/source/blender/python/gpu/gpu_py_shader.c +++ b/source/blender/python/gpu/gpu_py_shader.c @@ -145,7 +145,7 @@ static PyObject *bpygpu_shader_new(PyTypeObject *UNUSED(type), PyObject *args, P PyDoc_STRVAR(bpygpu_shader_bind_doc, ".. method:: bind()\n" "\n" -" Bind the shader object. Required to be able to change uniforms of this shader. \n" +" Bind the shader object. Required to be able to change uniforms of this shader.\n" ); static PyObject *bpygpu_shader_bind(BPyGPUShader *self) { -- cgit v1.2.3