[Pywikibot-commits] [Gerrit] [IMPROV] Convert comment to docstring - change (pywikibot/core)

jenkins-bot has submitted this change and it was merged. Change subject: [IMPROV] Convert comment to docstring ...................................................................... [IMPROV] Convert comment to docstring The comment above CosmeticChangesToolkit.commonsfiledesc in pywikibot.cosmetic_changes is converted into a proper docstring. Change-Id: Ifc5aa5f30eaea8ef5f1937ffab9cdc6eddc26f9f --- M pywikibot/cosmetic_changes.py 1 file changed, 8 insertions(+), 1 deletion(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/cosmetic_changes.py b/pywikibot/cosmetic_changes.py index c85548c..1fa7e21 100755 --- a/pywikibot/cosmetic_changes.py +++ b/pywikibot/cosmetic_changes.py @@ -886,8 +886,15 @@ text = textlib.replaceExcept(text, str(i), new[i], exceptions) return text - # Retrieved from "https://commons.wikimedia.org/wiki/Commons:Tools/pywiki_file_description_cleanup" def commonsfiledesc(self, text): + """ + Clean up file descriptions on the Wikimedia Commons. + + It is working according to [1] and works only on pages in the file + namespace on the Wikimedia Commons. + + [1]: https://commons.wikimedia.org/wiki/Commons:Tools/pywiki_file_description_cl… + """ if self.site.sitename() != u'commons:commons' or self.namespace == 6: return # section headers to {{int:}} versions -- To view, visit https://gerrit.wikimedia.org/r/225883 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Ifc5aa5f30eaea8ef5f1937ffab9cdc6eddc26f9f Gerrit-PatchSet: 3 Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Owner: XZise &lt;CommodoreFabianus(a)gmx.de&gt; Gerrit-Reviewer: John Vandenberg &lt;jayvdb(a)gmail.com&gt; Gerrit-Reviewer: Ladsgroup &lt;ladsgroup(a)gmail.com&gt; Gerrit-Reviewer: Merlijn van Deen &lt;valhallasw(a)arctus.nl&gt; Gerrit-Reviewer: Ricordisamoa &lt;ricordisamoa(a)openmailbox.org&gt; Gerrit-Reviewer: XZise &lt;CommodoreFabianus(a)gmx.de&gt; Gerrit-Reviewer: Xqt &lt;info(a)gno.de&gt; Gerrit-Reviewer: jenkins-bot <>