소스 검색

Adds glossary

Ask Solem 12 년 전
부모
커밋
38ee481d24
2개의 변경된 파일30개의 추가작업 그리고 0개의 파일을 삭제
  1. 29 0
      docs/glossary.rst
  2. 1 0
      docs/index.rst

+ 29 - 0
docs/glossary.rst

@@ -0,0 +1,29 @@
+.. _glossary:
+
+Glossary
+========
+
+.. glossary::
+    :sorted:
+
+    request
+        Task messages are converted to *requests* within the worker.
+        The request information is also available as the task's
+        :term:`context` (the ``task.request`` attribute).
+
+    calling
+        Sends a task message so that the task function is
+        :term:`executed <executing>` by a worker.
+
+    executing
+        Workers *execute* task :term:`requests <request>`.
+
+    apply
+        Originally a synonym to :term:`call <calling>` but used to signify
+        that a function is executed by the current process.
+
+    context
+        The context of a task contains information like the id of the task,
+        it's arguments and what queue it was delivered to.
+        It can be accessed as the tasks ``request`` attribute.
+        See :ref:`task-request-info`

+ 1 - 0
docs/index.rst

@@ -46,6 +46,7 @@ Contents
     changelog
     reference/index
     internals/index
+    glossary
 
 
 Indices and tables