Copy data path instructions is incorrect #84430

Closed
opened 2021-01-05 20:08:54 +01:00 by Leon Nicholls · 4 comments

In this section: https://docs.blender.org/api/2.91/info_api_reference.html#copy-data-path

The second paragraph mentions a tooltip that shows the data path, but that isn't there anymore in 2.91 (at least not on by default).

The result of the "Copy Data Path" is 'modifiers["Subdivision"].levels' and not 'modifiers["Subsurf"].levels', so the console command should rather be:
bpy.context.active_object.modifiers["Subdivision"].levels

And the following command should be:
bpy.context.active_object.modifiers["Subsurf"].levels = 2

Also, recommend moving the third paragraph starting with "Note that the text copied..." to between the two commands since it's confusing to talk about copying text before it's done with the "Copy Data Path" option.

In this section: https://docs.blender.org/api/2.91/info_api_reference.html#copy-data-path The second paragraph mentions a tooltip that shows the data path, but that isn't there anymore in 2.91 (at least not on by default). The result of the "Copy Data Path" is 'modifiers["Subdivision"].levels' and not 'modifiers["Subsurf"].levels', so the console command should rather be: bpy.context.active_object.modifiers["Subdivision"].levels And the following command should be: bpy.context.active_object.modifiers["Subsurf"].levels = 2 Also, recommend moving the third paragraph starting with "Note that the text copied..." to between the two commands since it's confusing to talk about copying text before it's done with the "Copy Data Path" option.
Author

Added subscriber: @norulesjustfeels

Added subscriber: @norulesjustfeels
Author

Just realized that I had to enable the Python Tooltips in the display preferences to see the tooltip. I don't think I saw that anywhere in the API docs, so it might be a good idea to add that explicitly since it looks like all the API docs assume both Developer Extras and Python Tooltips are enabled.

The rest of the issues raised in the bug still need to be considered.

Just realized that I had to enable the Python Tooltips in the display preferences to see the tooltip. I don't think I saw that anywhere in the API docs, so it might be a good idea to add that explicitly since it looks like all the API docs assume both Developer Extras and Python Tooltips are enabled. The rest of the issues raised in the bug still need to be considered.

This issue was referenced by blender/blender@a9c607e60e

This issue was referenced by blender/blender@a9c607e60ebfbb669694bda132af31734da9b709
Member

Changed status from 'Needs Triage' to: 'Resolved'

Changed status from 'Needs Triage' to: 'Resolved'
Aaron Carlisle self-assigned this 2021-01-07 00:55:07 +01:00
Sign in to join this conversation.
No Milestone
No project
No Assignees
3 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender-manual#84430
No description provided.