Page MenuHomePhabricator
Create Task
Maniphest T247111

Clarify the documentation of HTMLForm
Open, Needs TriagePublic
Actions

Description

While working on T246162 we hit some confusion with the documentation of HTMLForm
There is documentation on mediawiki.org and in the codebase which differs drastically.

Related discussion on https://gerrit.wikimedia.org/r/577340

Goals

  • It is clear how the mw.org page relates to the docblock code and how the mw.org is updated
  • The canonical documentation is up to date and states that it is the canonical source.
  • The @todo block regarding section should be removed from the docblock

Related Objects

Event Timeline

Jdlrobson created this task.Mar 6 2020, 6:07 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMar 6 2020, 6:07 PM
Jdlrobson added a project: Documentation.Mar 6 2020, 6:07 PM
Jdlrobson updated the task description. (Show Details)
Jdlrobson mentioned this in T246162: Put skin preference in the correct place.
Jdlrobson added subscribers: matmarex, Jdforrester-WMF.
Volker_E subscribed.Mar 7 2020, 3:58 AM
Jdlrobson moved this task from Incoming to Triaged but Future on the Web-Team-Backlog-Archived board.Mar 31 2020, 4:59 PM
Ashuro07 subscribed.Apr 3 2020, 5:08 PM

Hey, can I start working on this?

Aklapper added a comment.Apr 3 2020, 9:33 PM

@Ashuro07: Hi and welcome! See https://www.mediawiki.org/wiki/How_to_become_a_MediaWiki_hacker#Feedback,_questions_and_support
If you have a good technical understanding and can both find and compare the docs both on mediawiki.org and in the mediawiki/core git repo , sure! :)

Jdlrobson moved this task from Triaged but Future to Design on the Web-Team-Backlog-Archived board.Mar 3 2021, 9:52 PM
Jdlrobson edited projects, added Web-Team-Backlog-Archived (Design); removed Web-Team-Backlog-Archived.
Volker_E added a comment.Mar 4 2021, 6:45 AM

See also T188892: Improve HTMLForm documentation to cover more classes.

Jdlrobson moved this task from Design to Tracking on the Web-Team-Backlog-Archived board.Apr 30 2021, 8:31 PM
Jdlrobson edited projects, added Web-Team-Backlog-Archived (Tracking); removed Web-Team-Backlog-Archived (Design).
Jdlrobson removed a project: Web-Team-Backlog-Archived (Tracking).Oct 19 2021, 9:05 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits