Xqt created this task. Xqt added projects: Pywikibot, Pywikibot-Documentation, good first task. Restricted Application added subscribers: pywikibot-bugs-list, Aklapper. Restricted Application added a comment.
Thank you for tagging this task with #good_first_task <https://phabricator.wikimedia.org/tag/good_first_task/> for Wikimedia newcomers! Newcomers often may not be aware of things that may seem obvious to seasoned contributors, so please take a moment to reflect on how this task might look to somebody who has never contributed to Wikimedia projects. A #good_first_task <https://phabricator.wikimedia.org/tag/good_first_task/> is a self-contained, non-controversial task with a clear approach. It should be well-described with pointers to help a completely new contributor, for example it should clearly point to the codebase URL and provide clear steps to help a contributor get set up for success. We've included some guidelines at https://phabricator.wikimedia.org/tag/good_first_task/ ! Thank you for helping us drive new contributions to our projects <3 TASK DESCRIPTION Fix all SIG402 (“params-out-of-order”) docsig warnings in Pywikibot Summary: -------- There are numerous docstring parameter descriptions in Pywikibot where the parameter description does not match the parameter sequence of functions or methods. This triggers docsig SIG402 (“params-out-of-order”) warnings when running the docsig validator with capitalization enforcement enabled. These issues should be resolved to improve documentation consistency and to comply with the current docsig rules. Tasks: ------ 1. **Enable the SIG402 check locally**: Remove "SIG402" from disable part in pyproject.toml under [tool.docsig]: 2. **Install pre-commit** for the test if not already done 3. **Run pre-commit checks:** `pre-commit run docsig -a` to find the issues 4. **Update all relevant docstrings** 5. **Finally run pre-commit for all checks**: `pre-commit run -a` and fix the remaining issues. Repeat this step until all issues are solved 6. **Submit your patch** to the gerrit repository How to update docstrings ------------------------ Search for issues found by pre-commit. Re-order the :param: entries within the docstrings of a function or method. **Example:** Change such def function(param1, param2) -> None: """Function summary. :param param2: Description of param2. :param param1: Description of param1. """ to: def function(param1, param2) -> None: """Function summary. :param param1: Description of param1. :param param2: Description of param2. """ Dokumentation ------------- - https://docsig.io/en/latest/usage/messages/sig402-params-out-of-order.html - https://www.mediawiki.org/wiki/Manual:Pywikibot/Development TASK DETAIL https://phabricator.wikimedia.org/T413960 EMAIL PREFERENCES https://phabricator.wikimedia.org/settings/panel/emailpreferences/
_______________________________________________ pywikibot-bugs mailing list -- [email protected] To unsubscribe send an email to [email protected]
