Xqt added a comment.

  The lead documentation is on https://doc.wikimedia.org/pywikibot because it 
is generated from the code automatically.
  See also: 
https://www.mediawiki.org/wiki/Project:Pywikibot/Documentation_RFC#Options
  Maybe the MediaWiki pages should link to the corresponding doc pages or they 
should be synchronized somehow.
  
  > **Docs targeting bot users**
  
  For the script package and scripts description and usage refer 
https://doc.wikimedia.org/pywikibot/stable/scripts/index.html.
  
  > **Docs targeting bot developers**
  >
  > [ ] Need simple documentation for bot writers
  
  There is a basic.py script sample shipped with the framework, see 
https://doc.wikimedia.org/pywikibot/master/library_usage.html#basic-script
  
  > [ ] Need more code samples around available classes and methods on 
MediaWiki.org.
  
  I think this should be documentend within the code itself; doctests ensures 
that the samples are right
  
  Samples:
  
  - https://doc.wikimedia.org/pywikibot/stable/recipes.html
  - 
https://doc.wikimedia.org/pywikibot/master/api_ref/pywikibot.html?highlight=logging#pywikibot.LexemePage
  - 
https://doc.wikimedia.org/pywikibot/master/api_ref/pywikibot.html?highlight=logging#pywikibot.Site
  - 
https://doc.wikimedia.org/pywikibot/master/api_ref/pywikibot.html?highlight=logging#module-pywikibot.xmlreader
  - 
https://doc.wikimedia.org/pywikibot/master/api_ref/pywikibot.comms.html#module-pywikibot.comms.eventstreams
  - 
https://doc.wikimedia.org/pywikibot/master/api_ref/pywikibot.tools.html#module-pywikibot.tools
  - 
https://doc.wikimedia.org/pywikibot/master/api_ref/pywikibot.config.html#option-setting

TASK DETAIL
  https://phabricator.wikimedia.org/T308063

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: Xqt
Cc: Xqt, komla, Aklapper, TBurmeister, pywikibot-bugs-list, srishakatux, 
Fernandobacasegua34, 786, Suran38, Biggs657, Maberdour, Lalamarie69, Jyoo1011, 
JohnsonLee01, Juan90264, SHEKH, Dijkstra, Alter-paule, Beast1978, Un1tY, 
Khutuck, Zkhalido, Demian, apaskulin, Hook696, Pavithraes, Kent7301, 
joker88john, Viztor, CucyNoiD, Wenyi, Gaboe420, Giuliamocci, Cpaulf30, Af420, 
Bsandipan, Ivana_Isadora, Jayprakash12345, Tbscho, MayS, Lewizho99, Mdupont, 
JJMC89, Maathavan, Dvorapa, Altostratus, Neuronton, Avicennasis, mys_721tx, 
Dinoguy1000, Gryllida, jayvdb, Masti, Alchimista, Rfarrand, Jay8g, bd808, 
jeremyb
_______________________________________________
pywikibot-bugs mailing list -- pywikibot-bugs@lists.wikimedia.org
To unsubscribe send an email to pywikibot-bugs-le...@lists.wikimedia.org

Reply via email to