Reference code in Python API documentation (clickable link to see functions) #67674

Closed
opened 2019-07-25 16:32:14 +02:00 by Iemand Iets · 4 comments

Searching "reference code" with the documentation label didn't show up my suggestion. Sorry if it's a duplication.

Situation:
I want to see what bpy.ops.script.reload() does internally, so that I can see if it's possible to make changes to allow single add-on reloading.
In the documentation the function is referenced here: https://docs.blender.org/api/current/bpy.ops.script.html

Problems:

  • There is no reference link from the API documentation to the actual code.
  • Searching importlib doesn't find me anything on https://developer.blender.org/diffusion/B/browse/master/
  • Googling (Startpage) site:https://developer.blender.org/ importlib doesn't show up anything either.

Possible solutions:

  • Make the functions clickable, which then send you to the actual code of the API.
  • Index Blender websites on search engines, so that the most common way of how people search can be used (Code & Documentation)
  • Tell me how I can quickly find the code I want to find in the code repository of Blender :')
Searching "reference code" with the documentation label didn't show up my suggestion. Sorry if it's a duplication. **Situation**: I want to see what `bpy.ops.script.reload()` does internally, so that I can see if it's possible to make changes to allow single add-on reloading. In the documentation the function is referenced here: https://docs.blender.org/api/current/bpy.ops.script.html **Problems**: - There is no reference link from the API documentation to the actual code. - Searching `importlib` doesn't find me anything on https://developer.blender.org/diffusion/B/browse/master/ - Googling (Startpage) `site:https://developer.blender.org/ importlib` doesn't show up anything either. **Possible solutions**: - Make the functions clickable, which then send you to the actual code of the API. - Index Blender websites on search engines, so that the most common way of how people search can be used (Code & Documentation) - Tell me how I can quickly find the code I want to find in the code repository of Blender :')
Author

Added subscriber: @NumesSanguis-3

Added subscriber: @NumesSanguis-3

Added subscriber: @brecht

Added subscriber: @brecht

Changed status from 'Open' to: 'Archived'

Changed status from 'Open' to: 'Archived'
Brecht Van Lommel self-assigned this 2019-07-25 16:35:18 +02:00

These are operators implemented in the Blender C code. While it would be convenient to have a system that automatically links to the C code, that's really outside the scope of the bug tracker.

For this specific operator, you can search for SCRIPT_OT_reload in the Blender source code.

These are operators implemented in the Blender C code. While it would be convenient to have a system that automatically links to the C code, that's really outside the scope of the bug tracker. For this specific operator, you can search for `SCRIPT_OT_reload` in the Blender source code.
Sign in to join this conversation.
No Milestone
No project
No Assignees
2 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#67674
No description provided.