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

Docs: Fixes and improvements in API documentation

Browse Source 
Fixes several notable mistakes and missing information
regarding the API documentation (*.rst).

This will allow API stub generators like bpystubgen or
fake-bpy-module to produce more accurate result.

Differential Revision: https://developer.blender.org/D12639
This commit is contained in:
Xavier Cho
2021-10-22 18:27:03 -04:00
committed by Aaron Carlisle
parent 1d9e2dc954
commit 62d64bec2a
6 changed files with 62 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
source/blender/python/intern/bpy_rna.c
View File

@@ -8786,7 +8786,7 @@ void pyrna_free_types(void)
* - Should still be fixed - Campbell
*/
PyDoc_STRVAR(pyrna_register_class_doc,
".. method:: register_class(cls)\n"
".. function:: register_class(cls)\n"
"\n"
" Register a subclass of a Blender type class.\n"
"\n"
@@ -8971,7 +8971,7 @@ static int pyrna_srna_contains_pointer_prop_srna(StructRNA *srna_props,
}
PyDoc_STRVAR(pyrna_unregister_class_doc,
".. method:: unregister_class(cls)\n"
".. function:: unregister_class(cls)\n"
"\n"
" Unload the Python class from blender.\n"
"\n"