Page MenuHomePhabricator

Fix the jsdoc autosummarize plugin to work in combination with the markdown plugin
Closed, ResolvedPublic

Description

When using the markdown plugin, method summaries that do not end in a period get one added after the closing paragraph tag.

https://github.com/jsdoc/jsdoc/issues/1708

Event Timeline

Change 951990 had a related patch set uploaded (by TheDJ; author: TheDJ):

[mediawiki/extensions/TimedMediaHandler@master] Add jsdoc summarize plugin

https://gerrit.wikimedia.org/r/951990

Change 951990 merged by jenkins-bot:

[mediawiki/extensions/TimedMediaHandler@master] Add jsdoc summarize plugin

https://gerrit.wikimedia.org/r/951990

Change 980972 had a related patch set uploaded (by Jdlrobson; author: Catrope):

[mediawiki/core@master] jsdoc: Use the summarize plugin

https://gerrit.wikimedia.org/r/980972

Change 980972 merged by jenkins-bot:

[mediawiki/core@master] jsdoc: Use the summarize plugin

https://gerrit.wikimedia.org/r/980972

apaskulin triaged this task as Medium priority.Dec 19 2023, 11:48 PM

@TheDJ We ended up having to fork the summarize plugin from JSDoc to get class description summaries to work correctly, so if you want to apply the fix from your upstream pull request, the forked plugin is in plugins/summarize.js

Change #1025734 had a related patch set uploaded (by Esanders; author: Esanders):

[jsdoc/wmf-theme@master] Summarize plugin: Only add full stop if removed

https://gerrit.wikimedia.org/r/1025734

Change #1025734 merged by jenkins-bot:

[jsdoc/wmf-theme@master] Summarize plugin: Only add full stop if removed

https://gerrit.wikimedia.org/r/1025734

Change #1027072 had a related patch set uploaded (by TheDJ; author: TheDJ):

[mediawiki/extensions/TimedMediaHandler@master] Switch to jsdoc theme summarize plugin

https://gerrit.wikimedia.org/r/1027072

Change #1027072 merged by jenkins-bot:

[mediawiki/extensions/TimedMediaHandler@master] Switch to jsdoc theme summarize plugin

https://gerrit.wikimedia.org/r/1027072

Released as part of v1.0.1