diff options
author | Germano Cavalcante <germano.costa@ig.com.br> | 2021-03-16 18:48:00 +0300 |
---|---|---|
committer | Germano Cavalcante <germano.costa@ig.com.br> | 2021-03-16 18:48:39 +0300 |
commit | b71b1ae384a3e8cda43bb005a1beeddbf30f86ed (patch) | |
tree | 8be35833a092dca6e2939ccd03b3e83b8f04adcd /source/blender/python/gpu/gpu_py_batch.c | |
parent | 6b6bcbe60cfa8185b0d8c45939a63ccea39e4816 (diff) |
Python GPU: Improve the Python GPU API documentation
This fixes some errors of continuity and consistency of formatting on
https://docs.blender.org/api/current/gpu.html
This also details the description of some parameters.
Differential Revision: https://developer.blender.org/D10531
Diffstat (limited to 'source/blender/python/gpu/gpu_py_batch.c')
-rw-r--r-- | source/blender/python/gpu/gpu_py_batch.c | 16 |
1 files changed, 4 insertions, 12 deletions
diff --git a/source/blender/python/gpu/gpu_py_batch.c b/source/blender/python/gpu/gpu_py_batch.c index 8e803350b53..5214d156adf 100644 --- a/source/blender/python/gpu/gpu_py_batch.c +++ b/source/blender/python/gpu/gpu_py_batch.c @@ -295,18 +295,10 @@ PyDoc_STRVAR( "\n" " Reusable container for drawable geometry.\n" "\n" - " :arg type: One of these primitive types: {\n" - " `POINTS`,\n" - " `LINES`,\n" - " `TRIS`,\n" - " `LINE_STRIP`,\n" - " `LINE_LOOP`,\n" - " `TRI_STRIP`,\n" - " `TRI_FAN`,\n" - " `LINES_ADJ`,\n" - " `TRIS_ADJ`,\n" - " `LINE_STRIP_ADJ` }\n" - " :type type: `str`\n" + " :arg type: The primitive type of geometry to be drawn.\n" + " Possible values are `POINTS`, `LINES`, `TRIS`, `LINE_STRIP`, `LINE_LOOP`, `TRI_STRIP`, " + "`TRI_FAN`, `LINES_ADJ`, `TRIS_ADJ` and `LINE_STRIP_ADJ`.\n" + " :type type: str\n" " :arg buf: Vertex buffer containing all or some of the attributes required for drawing.\n" " :type buf: :class:`gpu.types.GPUVertBuf`\n" " :arg elem: An optional index buffer.\n" |