JSDoc: Add import section for addons. #30853
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related issue: -
Description
The PR adds the following section to doc pages:
We had this in place for the old docs and it seems it was a helpful feature for users. The only problem is we can't generate the section automatically since addons are not imported in a uniform fashion. E.g.
So the idea is to use a custom tag
@three_import
to classes and modules which documents the import. If we agree on that, I can file a follow-up PR updating all addons.