Merge pull request #341 from python-escpos/308-update-docstring-qr
fix links and impl (in qr-method) in docstrings
This commit is contained in:
commit
293b8632ff
|
@ -195,6 +195,7 @@ class Escpos(object):
|
||||||
:param native: True to render the code on the printer, False to render the code as an image and send it to the
|
:param native: True to render the code on the printer, False to render the code as an image and send it to the
|
||||||
printer (Default)
|
printer (Default)
|
||||||
:param center: Centers the code *default:* False
|
:param center: Centers the code *default:* False
|
||||||
|
:param impl: Image-printing-implementation, refer to :meth:`.image()` for details
|
||||||
"""
|
"""
|
||||||
# Basic validation
|
# Basic validation
|
||||||
if ec not in [QR_ECLEVEL_L, QR_ECLEVEL_M, QR_ECLEVEL_H, QR_ECLEVEL_Q]:
|
if ec not in [QR_ECLEVEL_L, QR_ECLEVEL_M, QR_ECLEVEL_H, QR_ECLEVEL_Q]:
|
||||||
|
@ -306,8 +307,8 @@ class Escpos(object):
|
||||||
.. todo:: For fixed-length standards with mandatory checksum (EAN, UPC),
|
.. todo:: For fixed-length standards with mandatory checksum (EAN, UPC),
|
||||||
compute and add the checksum automatically if missing.
|
compute and add the checksum automatically if missing.
|
||||||
|
|
||||||
:param bc: barcode format, see :py:func`~escpos.Escpos.barcode`
|
:param bc: barcode format, see :py:meth:`.barcode()`
|
||||||
:param code: alphanumeric data to be printed as bar code, see :py:func`~escpos.Escpos.barcode`
|
:param code: alphanumeric data to be printed as bar code, see :py:meth:`.barcode()`
|
||||||
:return: bool
|
:return: bool
|
||||||
"""
|
"""
|
||||||
if bc not in BARCODE_FORMATS:
|
if bc not in BARCODE_FORMATS:
|
||||||
|
@ -394,7 +395,7 @@ class Escpos(object):
|
||||||
*default*: A
|
*default*: A
|
||||||
|
|
||||||
:param check: If this parameter is True, the barcode format will be checked to ensure it meets the bc
|
:param check: If this parameter is True, the barcode format will be checked to ensure it meets the bc
|
||||||
requirements as defigned in the esc/pos documentation. See py:func:`~escpos.Escpos.check_barcode`
|
requirements as defigned in the esc/pos documentation. See :py:meth:`.check_barcode()`
|
||||||
for more information. *default*: True.
|
for more information. *default*: True.
|
||||||
|
|
||||||
:raises: :py:exc:`~escpos.exceptions.BarcodeSizeError`,
|
:raises: :py:exc:`~escpos.exceptions.BarcodeSizeError`,
|
||||||
|
|
Loading…
Reference in New Issue