To help outsiders understand our code better AND to help us document the code we are writing better we should make it possible to generate our documentation again.
Currently, it floods the console with errors.
To fix:
Task should run on src/, and ignore resources/dist/.
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Resolved | Jdlrobson | T162936 Improve developer happiness in reading web maintained extensions | |||
| Resolved | Jdlrobson | T158236 Make `npm run doc` work again for Page Previews |
Change 354455 had a related patch set uploaded (by Phuedx; owner: Phuedx):
[mediawiki/extensions/Popups@master] WIP Make JSDuck Work Again
Change 355143 had a related patch set uploaded (by Phuedx; owner: Phuedx):
[mediawiki/extensions/Popups@master] doc: Document preview/model module
Change 355144 had a related patch set uploaded (by Phuedx; owner: Phuedx):
[mediawiki/extensions/Popups@master] doc: Document wait module
Change 355145 had a related patch set uploaded (by Phuedx; owner: Phuedx):
[mediawiki/extensions/Popups@master] docs: Document schema module
^ Moving this to Needs Code Review so that the changes above'll be reviewed while I continue updating the documentation.
Change 355199 had a related patch set uploaded (by Phuedx; owner: Phuedx):
[mediawiki/extensions/Popups@master] doc: Document counts module
Change 355200 had a related patch set uploaded (by Phuedx; owner: Phuedx):
[mediawiki/extensions/Popups@master] doc: Document isEnabled module
Change 354455 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] doc: Replace JSDuck v5.3.4 with JSDoc v3.4.3
Change 355143 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] doc: Document preview/model module
Change 355144 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] doc: Document wait module
Change 355145 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] doc: Document schema module
Change 355199 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] doc: Document counts module
Change 355200 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] doc: Document isEnabled module
Change 355401 had a related patch set uploaded (by Phuedx; owner: Phuedx):
[mediawiki/extensions/Popups@master] doc: Document statsvInstrumentation module
Change 355474 had a related patch set uploaded (by Phuedx; owner: Phuedx):
[mediawiki/extensions/Popups@master] WIP doc: Document gateway modules
Change 355401 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] doc: Document statsvInstrumentation module
Change 355474 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] doc: Document gateway modules
Change 355634 had a related patch set uploaded (by Phuedx; owner: Phuedx):
[mediawiki/extensions/Popups@master] doc: Document userSettings module
Change 355634 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] doc: Document userSettings module
Change 355749 had a related patch set uploaded (by Phuedx; owner: Phuedx):
[mediawiki/extensions/Popups@master] doc: Document reducers/eventLogging module
^ That's the last change that I have time to submit right now.
To reiterate, npm run doc runs just fine now and the documentation is taking shape. So, if you want, this task can be moved to Ready for Signoff.
IIRC @Jdlrobson said he might be interested in tidying up some other modules. Have at it!
Change 355749 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] doc: Document reducers/eventLogging module
Change 355807 had a related patch set uploaded (by Jdlrobson; owner: Jdlrobson):
[mediawiki/extensions/Popups@master] Run doc generation on npm test
Change 355808 had a related patch set uploaded (by Jdlrobson; owner: Jdlrobson):
[mediawiki/extensions/Popups@master] Docs: Don't register methods as globals in documentation
I've made a few minor changes to ensure our documentation doesn't break again and is a little cleaner. ^^
I think this is good enough for the time being. More patches are welcome but I think we've done enough here and we are certainly outside the original scope of this task
Change 355807 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] Run doc generation on npm test
Change 355808 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] Docs: Don't register methods as globals in documentation
Fix looks good, documentation is generated without errors, my only concern is that now we have two folders doc and docs, it's a bit confusing.
Doc folder contains only our documentation, docs autogenerated code documentation. I would look much cleaner with only one doc folder and a subfolder (for example, doc/code) which would contain generated documentation.
Change 356069 had a related patch set uploaded (by Pmiazga; owner: Pmiazga):
[mediawiki/extensions/Popups@master] Generate docs inside doc folder
Change 356069 merged by jenkins-bot:
[mediawiki/extensions/Popups@master] Generate docs inside doc folder
@bmansurov thanks for reviewing my small fix, code looks great, documentation generation works properly, no errors.
Mass-moving all items tagged for MediaWiki 1.30.0-wmf.3, as that was never released; instead, we're using -wmf.4.