From f1a67ecb375b81555d5a4e9bbdad48a63bb6f1a4 Mon Sep 17 00:00:00 2001 From: Alan Guo Xiang Tan Date: Fri, 28 Mar 2025 09:59:25 +0800 Subject: [PATCH] DEV: Improvements to plugin API docs (#31988) Follow-up to af03873d37decf8dba4278fc38bfcde7747a79f4 --- lib/plugin/instance.rb | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/lib/plugin/instance.rb b/lib/plugin/instance.rb index 6d83c58774c..0c33118a612 100644 --- a/lib/plugin/instance.rb +++ b/lib/plugin/instance.rb @@ -1442,10 +1442,17 @@ class Plugin::Instance DiscoursePluginRegistry.register_topic_preloader_association(fields, self) end - # When loading /categories with topics, preload topic associations - # using register_category_list_topics_preloader_associations(:association_name) - def register_category_list_topics_preloader_associations(fields) - DiscoursePluginRegistry.register_category_list_topics_preloader_association(fields, self) + ## + # Allows plugins to preload topic associations when loading categories with topics. + # + # @param fields [Array] The topic associations to preload. + # + # @example Preload custom topic associations + # + # register_category_list_topics_preloader_associations(%i[some_topic_association some_other_topic_association]) + # + def register_category_list_topics_preloader_associations(associations) + DiscoursePluginRegistry.register_category_list_topics_preloader_association(associations, self) end private