Remove erroneous 'Legacy' comment on PayloadBuilder::TopicalEvents

Whilst it's true that config-driven documents won't use this
module - they'll use the ConfigurableAssociations instead - there
are plenty of content types that are still dependent on
PayloadBuilder::TopicalEvents until they too are converted to
being config-driven.

This commit makes that clear by inlining a comment on the module.

Author: ChrisBAshton

app/presenters/publishing_api/call_for_evidence_presenter.rb

@@ -47,7 +47,7 @@ def edition_links
         .extract(%i[organisations government])
         .merge(PayloadBuilder::People.for(call_for_evidence))
         .merge(PayloadBuilder::Roles.for(call_for_evidence))
-        .merge(PayloadBuilder::TopicalEvents.for(call_for_evidence)) # Legacy
+        .merge(PayloadBuilder::TopicalEvents.for(call_for_evidence))
     end
 
   private

app/presenters/publishing_api/consultation_presenter.rb

@@ -47,7 +47,7 @@ def edition_links
         .extract(%i[organisations government])
         .merge(PayloadBuilder::People.for(consultation))
         .merge(PayloadBuilder::Roles.for(consultation))
-        .merge(PayloadBuilder::TopicalEvents.for(consultation)) # Legacy
+        .merge(PayloadBuilder::TopicalEvents.for(consultation))
     end
 
   private

app/presenters/publishing_api/detailed_guide_presenter.rb

@@ -45,7 +45,7 @@ def edition_links
         related_guides: item.related_detailed_guide_content_ids,
         related_mainstream_content: related_mainstream_content_ids,
       ).merge(
-        PayloadBuilder::TopicalEvents.for(item), # Legacy
+        PayloadBuilder::TopicalEvents.for(item),
       )
     end
 

app/presenters/publishing_api/document_collection_presenter.rb

@@ -45,7 +45,7 @@ def edition_links
       )
       links[:documents] = item.content_ids.uniq
       links[:taxonomy_topic_email_override] = [item.taxonomy_topic_email_override] if item.taxonomy_topic_email_override
-      links.merge!(PayloadBuilder::TopicalEvents.for(item)) # Legacy
+      links.merge!(PayloadBuilder::TopicalEvents.for(item))
     end
 
     def document_type

app/presenters/publishing_api/payload_builder/topical_events.rb

@@ -1,3 +1,8 @@
+# Config-driven content types present their 'topical event' associations via the
+# `ConfigurableDocumentLinks` payload builder. When all content types have been
+# migrated to being config-driven, we'll be able to delete this module. For now,
+# it's the only means through which 'legacy' content types can present their
+# 'config-driven topical event' associations.
 module PublishingApi
   module PayloadBuilder
     class TopicalEvents

app/presenters/publishing_api/publication_presenter.rb

@@ -46,7 +46,7 @@ def edition_links
           government
         ],
       ).merge(
-        PayloadBuilder::TopicalEvents.for(item), # Legacy
+        PayloadBuilder::TopicalEvents.for(item),
       ).merge(
         related_statistical_data_sets:,
       ).merge(

app/presenters/publishing_api/speech_presenter.rb

@@ -62,7 +62,7 @@ def links
         ],
       )
       links.merge!(links_for_speaker)
-      links.merge!(PayloadBuilder::TopicalEvents.for(item)) # Legacy
+      links.merge!(PayloadBuilder::TopicalEvents.for(item))
       links.merge!(PayloadBuilder::Roles.for(item))
       links.merge!(PayloadBuilder::People.for(item))
     end