Merge branch 'master' into blender2.8
[blender.git] / source / blender / python / gpu / gpu_py_element.c
index 2462c22214633c41500ba04ff0a9c9b4ef74d69c..12027d2e2b80c2ed2f1dfcb7c17e237d6ff7d142 100644 (file)
@@ -196,19 +196,20 @@ static void bpygpu_IndexBuf_dealloc(BPyGPUIndexBuf *self)
 }
 
 PyDoc_STRVAR(py_gpu_element_doc,
-"GPUIndexBuf(type, seq)\n"
+".. class:: GPUIndexBuf(type, seq)\n"
 "\n"
-"Contains a VBO."
+"   Contains an index buffer.\n"
 "\n"
-"   :param prim_type:\n"
-"      One of these primitive types: {\n"
-"      'POINTS',\n"
-"      'LINES',\n"
-"      'TRIS',\n"
-"      'LINE_STRIP_ADJ'}\n"
+"   :param type: One of these primitive types: {\n"
+"      `POINTS`,\n"
+"      `LINES`,\n"
+"      `TRIS`,\n"
+"      `LINE_STRIP_ADJ` }\n"
 "   :type type: `str`\n"
-"   :param seq: Sequence of integers.\n"
-"   :type buf: `Any 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)