Page MenuHomePhabricator

pep257: property.setters no longer need docstrings
Closed, ResolvedPublic

Description

https://github.com/GreenSteam/pep257/pull/107 has been merged, but is not yet released on https://pypi.python.org/pypi/pep257

When it is released, and if we can force all our tools to use the new released version...

  1. we can remove non-informative docstrings from our .setters ,
  2. we should update the property getter docstring to be less 'get' specific.

tools.LazyRegex.flags and tools.LazyRegex.raw are clear examples of a docstring on .setter which is unnecessary

Page.text is a case where we shouldnt change anything, as the have very important information which is different.

I think Bot.current_page and Bot.site could be improved by merging the docstrings.

api's Request.mime setter docstring could be merged into the getter docstring, but I'm not 100% sure about that one.

threadedhttp 's .data look like it shouldnt be changed.

Details

Related Changes in Gerrit:

Event Timeline

jayvdb raised the priority of this task from to Lowest.
jayvdb updated the task description. (Show Details)
jayvdb added a project: Pywikibot.
jayvdb subscribed.
Restricted Application added subscribers: Aklapper, Unknown Object (MLST). · View Herald TranscriptApr 28 2015, 2:35 AM

Change 447383 had a related patch set uploaded (by Xqt; owner: Xqt):
[pywikibot/core@master] [IMPR] Delete non-informative doc strings

https://gerrit.wikimedia.org/r/447383

Change 447383 merged by jenkins-bot:
[pywikibot/core@master] [IMPR] Delete non-informative doc strings

https://gerrit.wikimedia.org/r/447383