Add-on Tutorial documentation should probably require reader to enable Developer Extras #85625

New Issue

Éric Redon · 2021-02-14T13:37:03+01:00

Éric Redon commented

2021-02-14 13:37:03 +01:00

As a developer willing to experiment with Blender add-ons, I began following the steps described in the following section of the documentation:
Advanced » Scripting & Extending Blender » Add-on Tutorial

My progress got rapidly blocked when, in the “Your First Add-on” chapter, I tried to find the operator of the example add-on in the Operator Search menu (f3).
The tutorial is very clear and even has a nice screenshot, but the operator was nowhere to be found.
https://docs.blender.org/manual/en/2.91/advanced/scripting/addon_tutorial.html#your-first-add-on

I only found out by reading https://developer.blender.org/T80345 that it was probably because a feature:

in Blender 2.90 only options avaliable through a menu will show up in the search operator F3
A temporary fix - [x] would be to enable Developer Extras which allows the search operator to find funtions not in menus.

So my suggestion would be to add an introduction sentence or paragraph in the documentation, with a requirement for the reader to enable Developer Extra, explaining that it allows the search operator to find functions of the add-on being developed.

As a developer willing to experiment with Blender add-ons, I began following the steps described in the following section of the documentation: Advanced » Scripting & Extending Blender » Add-on Tutorial My progress got rapidly blocked when, in the “Your First Add-on” chapter, I tried to find the operator of the example add-on in the Operator Search menu (f3). The tutorial is very clear and even has a nice screenshot, but the operator was nowhere to be found. https://docs.blender.org/manual/en/2.91/advanced/scripting/addon_tutorial.html#your-first-add-on I only found out by reading https://developer.blender.org/T80345 that it was probably because a feature: > in Blender 2.90 only options avaliable through a menu will show up in the search operator F3 > A temporary fix - [x] would be to enable Developer Extras which allows the search operator to find funtions not in menus. So my suggestion would be to add an introduction sentence or paragraph in the documentation, with a requirement for the reader to enable Developer Extra, explaining that it allows the search operator to find functions of the add-on being developed.

Éric Redon commented

2021-02-14 13:37:03 +01:00

Added subscriber: @Coox