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 SIG305 (“description-not-capitalized”) docsig warnings in Pywikibot Summary: -------- There are numerous docstring parameter descriptions in Pywikibot where the description text does not start with a capital letter. This triggers docsig SIG305 (“description-not-capitalized”) 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 SIG305 check locally**: Remove "SIG305" 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 patterns like: :param foo: description starts with lower-case :return: explanation begins with lower-case Fix them to: :param foo: Description starts with lower-case. :return: Explanation starts with lower-case. Rules: - The first word of each parameter/return description must begin with a capital letter. - If descriptions contain multiple sentences, only check the first sentence. - Avoid changing the meaning of the text. Dokumentation ------------- - https://docsig.io/en/latest/usage/messages/sig305-description-not-capitalized.html - https://www.mediawiki.org/wiki/Manual:Pywikibot/Development TASK DETAIL https://phabricator.wikimedia.org/T413953 EMAIL PREFERENCES https://phabricator.wikimedia.org/settings/panel/emailpreferences/
_______________________________________________ pywikibot-bugs mailing list -- [email protected] To unsubscribe send an email to [email protected]
