Skip to content

Commit bae6303

Browse files
committed
docs(plugin-email): keep the internal sweep's name out of the published docblock
The exported bootstrapDeclaredEmailTemplates docblock is carried into the published index.d.ts, where a link to the module-internal function named an unexported symbol. The delegation note moves into the function body. Claude-Session: https://claude.ai/code/session_011K3zqE8Pv1Evw5hc8tZCnN Co-authored-by: Claude <noreply@anthropic.com>
1 parent 7293048 commit bae6303

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

‎packages/plugins/plugin-email/src/bootstrap-declared-email-templates.ts‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -367,18 +367,20 @@ export async function deactivateDeclaredEmailTemplate(
367367
* ObjectQL registry (falling back to the metadata service). Idempotent and safe
368368
* to run on every boot.
369369
*
370-
* The published signature, unchanged. It delegates to
371-
* {@link bootstrapEffectiveEmailTemplates} with no sources, so an external
372-
* caller reads the registry exactly as before — the declarations plus the
373-
* env-wide overlays boot hydration registered. The plugin's own boot wiring
374-
* calls the effective form directly.
370+
* The published signature, unchanged: an external caller reads the registry
371+
* exactly as before — the declarations plus the env-wide overlays boot
372+
* hydration registered.
375373
*/
376374
export async function bootstrapDeclaredEmailTemplates(
377375
engine: IDataEngine,
378376
metadataService: any,
379377
logger?: Logger,
380378
object = EMAIL_TEMPLATE_OBJECT,
381379
): Promise<BootstrapDeclaredEmailTemplatesResult> {
380+
// [#21785] The one sweep body, with no sources. The plugin's own boot wiring
381+
// calls the effective form directly. Said here, not in the docblock above:
382+
// the docblock ships in the published `.d.ts`, and the module-internal name
383+
// is not part of that surface.
382384
return bootstrapEffectiveEmailTemplates(engine, metadataService, undefined, logger, object);
383385
}
384386

0 commit comments

Comments
 (0)