Changeset 12920 for main/waeup.kofa/trunk/src/waeup/kofa/accesscodes

Timestamp:

9 May 2015, 21:48:17 (10 years ago)

Author:

Henrik Bettermann

Message:

Untegrate doctests into sphinx docu.

Location:

main/waeup.kofa/trunk/src/waeup/kofa/accesscodes

Files:

• accesscode.txt (modified) (14 diffs)
• api.txt (deleted)
• browser.txt (modified) (5 diffs)

main/waeup.kofa/trunk/src/waeup/kofa/accesscodes/accesscode.txt

@@ -1 @@
-:mod:`waeup.kofa.accesscodes.accesscode` -- access codes (aka PINs)
-*******************************************************************
+Access Codes (aka PINs)
+***********************
 
 .. module:: waeup.kofa.accesscodes.accesscode
@@ -9 +9 @@
 .. :NOlayer: waeup.kofa.testing.KofaUnitTestLayer
 
-About access-codes
+About Access Codes
 ==================
 
@@ -34 +34 @@
 
 
-AccessCode
-==========
+Access Code
+===========
 
 .. class:: AccessCode(batch_serial, random_num[,invalidation_date=None[, student_id=None]])
 
-   You normally shouldn't create standalone access-codes. Use
+   You normally shouldn't create standalone access codes. Use
    instances of :class:`AccessCodeBatch` instead as they generate them
    (in masses) and care for them.
@@ -47 +47 @@
    :class:`AccessCodeBatch`) to be kept.
 
-   Access-codes can have three states: unused, used, and
-   disabled. While still unused but enabled access-codes are reflected
+   Access codes can have three states: unused, used, and
+   disabled. While still unused but enabled access codes are reflected
    by an empty ``invalidation_date`` (set to ``None``), an already
    used (invalidated) code provides an invalidation date.
 
-   In case of misuse or similar cases access-codes can also be
+   In case of misuse or similar cases access codes can also be
    completely disabled by setting the ``disabled`` attribute to
    ``True``.
@@ -133 +133 @@
 
 
-AccessCodeBatch
-===============
+Access Code Batch
+=================
 
 .. class:: AccessCodeBatch(creation_date, creator, batch_prefix, cost, entry_num, num)
 
-   Create a batch of access-codes.
+   Create a batch of access codes.
 
    :param creation_date: python datetime
@@ -152 +152 @@
    :class:`waeup.kofa.accesscodes.interfaces.IAccessCodeBatch`.
 
-   When creating a batch, all entries (access-codes) are generated as
+   When creating a batch, all entries (access codes) are generated as
    well.
 
@@ -170 +170 @@
    .. attribute:: entry_num
 
-      Number of entries (access-codes) inside the batch.
+      Number of entries (access codes) inside the batch.
 
    .. attribute:: invalidated_num
@@ -298 +298 @@
       Lookup is done via local BTrees and therefore pretty fast.
 
-      Returns a list of access-codes found or empty list.
+      Returns a list of access codes found or empty list.
 
 
@@ -312 +312 @@
     True
 
-Creating a batch of three access-codes, with a cost of ``12.12`` per
+Creating a batch of three access codes, with a cost of ``12.12`` per
 code, the batch prefix ``APP``, batch number ``10``, creator ID
 ``Fred`` and some arbitrary creation date:
@@ -321 +321 @@
     ...   datetime.datetime(2009, 12, 23), 'Fred','APP', 12.12, 3, num=10)
 
-Getting all access-codes from a batch:
+Getting all access codes from a batch:
 
     >>> ac_codes = batch.entries()
@@ -472 +472 @@
 #    []
 
-AccessCodeBatchContainer
-========================
+Access Code Batch Container
+===========================
 
 .. class:: AccessCodeBatchContainer()
@@ -540 +540 @@
         be a string containing the full student ID.
 
-Examples:
----------
+Examples
+--------
 
 Creating a batch container:
@@ -586 +586 @@
 
 
-Access code plugin
+Access Code Plugin
 ==================
 
@@ -592 +592 @@
 
   A `waeup.kofa` plugin that updates existing Kofa university
-  instances so that they provide support for access-codes.
+  instances so that they provide support for access codes.
 
   .. attribute:: grok.implements(IKofaPluggable)

main/waeup.kofa/trunk/src/waeup/kofa/accesscodes/browser.txt

@@ -1 @@
-:mod:`waeup.kofa.accesscodes.browser` -- UI components for access-codes
-***********************************************************************
+UI Components for Access Codes
+******************************
 
 .. module:: waeup.kofa.accesscodes.browser
@@ -45 +45 @@
 
 
-Access-code management screen
+Access Code Management Screen
 =============================
 
@@ -66 +66 @@
     ...
 
-Adding batches
+Adding Batches
 ==============
 
@@ -336 +336 @@
 
 Enabling and Disabling Found Access Codes
------------------------------------------
+=========================================
 
 If a search is successfull, we can enable or disable the found access
@@ -421 +421 @@
 
 
-
 Archive files
 -------------