Docs of RNA_object instance_type and instanced_collection properties improved
Needs ReviewPublic
Actions

Authored by Zdenek Dolezal (zdeno) on Apr 8 2022, 4:43 PM.

Details

Reviewers

Campbell Barton (campbellbarton)
Bastien Montagne (mont29)
Brecht Van Lommel (brecht)

Summary

This is clear when used in the UI, the collection property is displayed directly below the instance_type, but when working with the Python API it may not be obvious that instance_type has to be set to COLLECTION so the collection from instanced_collection is actually instanced.

Diff Detail

Event Timeline

Zdenek Dolezal (zdeno) requested review of this revision.Apr 8 2022, 4:43 PM

Zdenek Dolezal (zdeno) created this revision.

Zdenek Dolezal (zdeno) retitled this revision from Docs of Object instance_type and instanced_collection properties improved to Docs of RNA_object instance_type and instanced_collection properties improved.Apr 8 2022, 4:46 PM

Zdenek Dolezal (zdeno) added reviewers: Campbell Barton (campbellbarton), Bastien Montagne (mont29), Brecht Van Lommel (brecht).Apr 8 2022, 4:49 PM

Thanks, but tooltips for properties shown in the UI should not use Python property names, but rather refer to their UI names.

This revision now requires changes to proceed.Apr 8 2022, 5:36 PM

Description of referenced properties changed to their labels instead of python names.

Campbell Barton (campbellbarton) added inline comments.Apr 29 2022, 5:25 AM

source/blender/makesrna/intern/rna_object.c
191	This reads awkwardly since the enum name and the property name are the same, perhaps this could `Use this object to instance the "Collection"` `Enable collection instancing for the referenced "Collection"`
3628	Would use the UI name `"Collection"`

Revision Contents
Changeset List

Path

Size

source/

blender/

makesrna/

intern/

rna_object.c

8 lines

Diff 50256

View Options

source/blender/makesrna/intern/rna_object.c

Docs of RNA_object instance_type and instanced_collection properties improvedNeeds ReviewPublicActions