Xqt added a comment.
Sorry I haven't documented all the reasons why I discarded this change. The basic idea behind this is listed inT277396. I've searched for a linter and found darglint but there where to many problems with it and so much work that all of the errors have must be hidden. The conversion was prepared because darglint does not support epytext. reST is the preferred format because we use sphinx for our generated documention. The conversions are made in `docs/conf.py.` > Do we presently perform some sort of epytext check? What kind of validation do we need to move forward with your commit? Currently the only check is made by sphinx but there is no code validation. See also T277396 <https://phabricator.wikimedia.org/T277396> > Does darglint or the ReST conversion cause the problem, and where are you seeing the yields? Thats about DAR301 and DAR302 I think. See https://github.com/terrencepreilly/darglint/issues/165. Sphinx does not support a `yield` field but darglint supposes it. > What kind of problem are you seeing? I use Sphinx and haven't experienced a problem documenting kwargs Sphinx handled *args and *+kwargs correctly but darglint doesn't. You cannot use `:param kwargs:` or `keyword` or `ivar` with darglint but with Sphinx > What do you mean by 'keyword token' and what sort of problem are you experiencing? same as above. Keyword token is for keywords passed through **kwargs which may be documented but is not allowed in darglint. See https://doc.wikimedia.org/pywikibot/master/scripts/scripts.html#module-scripts.harvest_template for example TASK DETAIL https://phabricator.wikimedia.org/T278046 EMAIL PREFERENCES https://phabricator.wikimedia.org/settings/panel/emailpreferences/ To: Xqt Cc: atagar, jayvdb, Huji, Aklapper, Xqt, pywikibot-bugs-list, Shalomori123, Jyoo1011, JohnsonLee01, SHEKH, Dijkstra, Khutuck, Zkhalido, Urstrulykkr, Viztor, Wenyi, Tbscho, MayS, Mdupont, JJMC89, Dvorapa, Altostratus, Avicennasis, mys_721tx, Masti, Alchimista
_______________________________________________ pywikibot-bugs mailing list -- [email protected] To unsubscribe send an email to [email protected]
