浏览代码

pep257 -> pydocstyle

Ask Solem 8 年之前
父节点
当前提交
3a8583da4b
共有 7 个文件被更改,包括 12 次插入8 次删除
  1. 3 1
      celery/apps/beat.py
  2. 3 1
      celery/apps/worker.py
  3. 1 1
      celery/exceptions.py
  4. 1 1
      celery/local.py
  5. 2 2
      celery/worker/components.py
  6. 1 1
      requirements/pkgutils.txt
  7. 1 1
      setup.cfg

+ 3 - 1
celery/apps/beat.py

@@ -1,5 +1,7 @@
 # -*- coding: utf-8 -*-
 # -*- coding: utf-8 -*-
-"""This module is the 'program-version' of :mod:`celery.beat`.
+"""Beat command-line program.
+
+This module is the 'program-version' of :mod:`celery.beat`.
 
 
 It does everything necessary to run that module
 It does everything necessary to run that module
 as an actual application, like installing signal handlers
 as an actual application, like installing signal handlers

+ 3 - 1
celery/apps/worker.py

@@ -1,5 +1,7 @@
 # -*- coding: utf-8 -*-
 # -*- coding: utf-8 -*-
-"""This module is the 'program-version' of :mod:`celery.worker`.
+"""Worker command-line program.
+
+This module is the 'program-version' of :mod:`celery.worker`.
 
 
 It does everything necessary to run that module
 It does everything necessary to run that module
 as an actual application, like installing signal handlers,
 as an actual application, like installing signal handlers,

+ 1 - 1
celery/exceptions.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
 # -*- coding: utf-8 -*-
-"""This module contains all exceptions used by the Celery API."""
+"""Celery error types."""
 from __future__ import absolute_import, unicode_literals
 from __future__ import absolute_import, unicode_literals
 
 
 import numbers
 import numbers

+ 1 - 1
celery/local.py

@@ -307,7 +307,7 @@ class Proxy(object):
 
 
 
 
 class PromiseProxy(Proxy):
 class PromiseProxy(Proxy):
-    """This is a proxy to an object that hasn't yet been evaulated.
+    """Proxy that evaluates object once.
 
 
     :class:`Proxy` will evaluate the object each time, while the
     :class:`Proxy` will evaluate the object each time, while the
     promise will only evaluate it once.
     promise will only evaluate it once.

+ 2 - 2
celery/worker/components.py

@@ -31,7 +31,7 @@ as early as possible.
 
 
 
 
 class Timer(bootsteps.Step):
 class Timer(bootsteps.Step):
-    """This step initializes the internal timer used by the worker."""
+    """Timer bootstep."""
 
 
     def create(self, w):
     def create(self, w):
         if w.use_eventloop:
         if w.use_eventloop:
@@ -190,7 +190,7 @@ class Beat(bootsteps.StartStopStep):
 
 
 
 
 class StateDB(bootsteps.Step):
 class StateDB(bootsteps.Step):
-    """This bootstep sets up the workers state db if enabled."""
+    """Bootstep that sets up between-restart state database file."""
 
 
     def __init__(self, w, **kwargs):
     def __init__(self, w, **kwargs):
         self.enabled = w.statedb
         self.enabled = w.statedb

+ 1 - 1
requirements/pkgutils.txt

@@ -2,7 +2,7 @@ setuptools>=20.6.7
 wheel>=0.29.0
 wheel>=0.29.0
 flake8>=2.5.4
 flake8>=2.5.4
 flakeplus>=1.1
 flakeplus>=1.1
-pep257
+pydocstyle
 tox>=2.3.1
 tox>=2.3.1
 sphinx2rst>=1.0
 sphinx2rst>=1.0
 cyanide>=1.0.1
 cyanide>=1.0.1

+ 1 - 1
setup.cfg

@@ -13,7 +13,7 @@ all_files = 1
 ignore = N806, N802, N801, N803
 ignore = N806, N802, N801, N803
 
 
 [pep257]
 [pep257]
-ignore = D102,D104,D203,D105
+ignore = D102,D104,D203,D105,D213
 
 
 [bdist_rpm]
 [bdist_rpm]
 requires = pytz >= 2011b
 requires = pytz >= 2011b