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

Closed
opened 4 years ago by NumesSanguis-3 · 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 :')
Poster

Added subscriber: @NumesSanguis-3

Added subscriber: @NumesSanguis-3
brecht commented 4 years ago
Owner

Added subscriber: @brecht

Added subscriber: @brecht
brecht commented 4 years ago
Owner

Changed status from 'Open' to: 'Archived'

Changed status from 'Open' to: 'Archived'
brecht closed this issue 4 years ago
brecht self-assigned this 4 years ago
brecht commented 4 years ago
Owner

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 Label
good first issue
legacy module/Animation & Rigging
legacy module/Core
legacy module/Development Management
legacy module/Eevee & Viewport
legacy module/Grease Pencil
legacy module/Modeling
legacy module/Nodes & Physics
legacy module/Pipeline, Assets & IO
legacy module/Platforms, Builds, Tests & Devices
legacy module/Python API
legacy module/Rendering & Cycles
legacy module/Sculpt, Paint & Texture
legacy module/User Interface
legacy module/VFX & Video
legacy project/2.81
legacy project/2.82
legacy project/2.83
legacy project/2.90
legacy project/2.91
legacy project/2.92
legacy project/2.93
legacy project/3.0
legacy project/3.1
legacy project/3.2
legacy project/3.3
legacy project/3.4
legacy project/3.5
legacy project/Animation & Rigging
legacy project/Asset Browser Project Overview
legacy project/Audio
legacy project/BF Blender: Next
legacy project/Compositing
legacy project/Core
legacy project/Cycles
legacy project/Datablocks and Libraries
legacy project/Development Management
legacy project/Documentation
legacy project/EEVEE & Viewport
legacy project/Game Engine
legacy project/Game Physics
legacy project/Geometry Nodes
legacy project/Good First Issue
legacy project/Grease Pencil
legacy project/Images & Movies
legacy project/Import/Export
legacy project/Infrastructure: Websites
legacy project/Line Art
legacy project/Modeling
legacy project/Modifiers
legacy project/Nodes
legacy project/Nodes & Physics
legacy project/Physics
legacy project/Pipeline, Assets & I/O
legacy project/Platform: Windows
legacy project/Python API
legacy project/Render & Cycles
legacy project/Sculpt, Paint & Texture
legacy project/Straightforward Issue
legacy project/Tracker Curfew
legacy project/Translations
legacy project/User Interface
legacy project/UV Editing
legacy project/VFX & Video
legacy project/Video Sequencer
Priority › High
Priority › Low
Priority › Normal
Status › Archived
Status › Confirmed
Status › Duplicate
Status › Needs Information from Developers
Status › Needs Information from User
Status › Needs Triage
Status › Resolved
straightforward issue
Type › Bug
Type › Design
Type › Known Issue
Type › Patch
Type › Report
Type › To Do
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date

No due date set.

Dependencies

No dependencies set.

Reference: blender/documentation#67674
Loading…
There is no content yet.