srishakatux created this task. srishakatux added projects: Pywikibot, Developer-Advocacy. Restricted Application added subscribers: pywikibot-bugs-list, Aklapper.
TASK DESCRIPTION Some observations while developing workshop materials around Pywikibot as part of the #Small-wiki-toolkits <https://phabricator.wikimedia.org/tag/small-wiki-toolkits/> initiative: **Scripts documentation needs a review and update** https://www.mediawiki.org/wiki/Manual:Pywikibot/Scripts [ ] Documents kept only for historical purposes are still linked from the "scripts" page. [ ] Some pages do not demonstrate the use of essential parameters well [ ] Some pages still use options or parameters that are deprecated [ ] Some scripts are even missing pages and still appear in red links on the landing page [ ] Scripts categorization needs a review and overhaul. For example, some scripts that do category work (e.g., 'category.py') are placed under the "Main bot scripts" section when they should be under the "Categories" section. **Insufficient documentation for getting started with writing scripts** [ ] Code samples need a review. For example, Pywikibot as a library page has a syntax error in the code sample (https://doc.wikimedia.org/pywikibot/master/library_usage.html). __main should be __main__, line 26 should be 'options' not 'args' [ ] Need simple documentation for bot writers. As an example, the following page includes a basic script for building new scripts (but it is nowhere near to simple and can be further broken down into smaller modules): https://www.mediawiki.org/wiki/Manual:Pywikibot/Create_your_own_script [ ] Need more code samples around available classes and methods on MediaWiki.org. TASK DETAIL https://phabricator.wikimedia.org/T308063 EMAIL PREFERENCES https://phabricator.wikimedia.org/settings/panel/emailpreferences/ To: srishakatux Cc: komla, Aklapper, TBurmeister, pywikibot-bugs-list, srishakatux, Maberdour, Jyoo1011, JohnsonLee01, SHEKH, Dijkstra, Khutuck, Zkhalido, Demian, Pavithraes, Viztor, Wenyi, Jayprakash12345, Tbscho, MayS, Mdupont, JJMC89, Dvorapa, Altostratus, Avicennasis, mys_721tx, Xqt, Gryllida, jayvdb, Masti, Alchimista, Rfarrand, bd808, jeremyb
_______________________________________________ pywikibot-bugs mailing list -- [email protected] To unsubscribe send an email to [email protected]
