blender/doc/python_api
Michal Srb be5afe9987 PyAPI Docs: Add default values for bmesh API
This diff improves the docs for bmesh by adding the default values to all methods. This is motivated by this issue https://github.com/nutti/fake-bpy-module/issues/118 in fake-bpy-module which generates a typed API for authoring Blender scripts and addons from the docs.

After this diff gets merged, the Blender docs get updated, and `fake-bpy-module` gets regenerated, the type signatures in `fake-bpy-module` will match the reality of Blender's API.

Here's a diff for the docs using the modified script:
https://gist.github.com/xixixao/1c83153adbcefbe0859f9cc9ba757d46

I "hardcoded" the defaults based on the types of the arguments, after some testing and consulting the Blender .c source for these APIs.

Here's a test script that verifies that the arguments with defaults added in this diff are indeed not required by Blender 3.3: https://gist.github.com/xixixao/adc4e5a076e80a63735bd60c7c9e7a0d

I made the minimum changes required to get this doc generation script fixed, but let me know if I should restructure this script more.

I also amended the comments of three args, 2 to align them with Python (NULL -> None) and one to mark it as optional (CurveProfile).

Reviewed By: Blendify

Differential Revision: https://developer.blender.org/D16400
2022-12-07 15:48:41 -06:00
..
examples PyGPU: call 'GPU_shader_bind' in 'GPUShader.uniform_' methods 2022-09-19 09:40:20 -03:00
rst Add 'work around' to accessing data from volatile iterators in py API. 2022-11-30 17:04:37 +01:00
static PyDoc: remove CSS override for scrolling long enum lists 2022-06-02 10:03:00 +10:00
templates Py Docs: Implement version switch to switch between versions on the website 2022-02-03 14:25:26 -05:00
requirements.txt PyDocs: Upgrade Theme to 1.1.0 2022-11-02 22:37:39 -04:00
rst_from_bmesh_opdefines.py PyAPI Docs: Add default values for bmesh API 2022-12-07 15:48:41 -06:00
sphinx_changelog_gen.py PyDoc: hide overly long titles from the side-bar 2022-09-15 14:34:23 +10:00
sphinx_doc_gen.py Python API Docs: document when fields use mathutils types. 2022-11-28 00:33:41 +02:00
sphinx_doc_gen_monkeypatch.py Cleanup: remove "<pep8 compliant>" from headers 2022-06-02 20:16:20 +10:00