Merge pull request #66 from heuer/feature/upc_docs

Added docs for make_ean, fixed Sphinx docs

Author: Hugo Osvaldo Barrera

barcode/upc.py

@@ -8,28 +8,27 @@
 
 from barcode.base import Barcode
 from barcode.charsets import upc as _upc
-from barcode.errors import (
-    IllegalCharacterError,
-    NumberOfDigitsError,
-)
+from barcode.errors import IllegalCharacterError, NumberOfDigitsError
 
 
 class UniversalProductCodeA(Barcode):
-    """Initializes new UPC-A barcode.
-
-    :parameters:
-        upc : String
-            The upc number as string.
-        writer : barcode.writer Instance
-            The writer to render the barcode (default: SVGWriter).
-        make_ean: boolean
-    """
+    """Universal Product Code (UPC) barcode.
 
+    UPC-A consists of 12 numeric digits.
+    """
     name = 'UPC-A'
 
     digits = 11
 
     def __init__(self, upc, writer=None, make_ean=False):
+        """Initializes new UPC-A barcode.
+
+        :param str upc: The upc number as string.
+        :param writer: barcode.writer instance. The writer to render the barcode
+                (default: SVGWriter).
+        :param bool make_ean: Indicates if a leading zero should be added to the
+                barcode. This converts the UPC into a valid European Article Number (EAN).
+        """
         self.ean = make_ean
         upc = upc[:self.digits]
         if not upc.isdigit():
@@ -61,7 +60,7 @@ def calculate_checksum(self):
         """Calculates the checksum for UPCA/UPC codes
 
         :return: The checksum for 'self.upc'
-        :rtype: Integer
+        :rtype: int
         """
         def sum_(x, y):
             return int(x) + int(y)
@@ -79,7 +78,7 @@ def build(self):
         """Builds the barcode pattern from 'self.upc'
 
         :return: The pattern as string
-        :rtype: String
+        :rtype: str
         """
         code = _upc.EDGE[:]
 
@@ -98,7 +97,7 @@ def build(self):
     def to_ascii(self):
         """Returns an ascii representation of the barcode.
 
-        :rtype: String
+        :rtype: str
         """
 
         code = self.build()