From ba468bcb5aef087788d6d60f4e10cb34b252fc02 Mon Sep 17 00:00:00 2001 From: Patrick Kanzler Date: Wed, 6 Sep 2023 00:49:20 +0200 Subject: [PATCH] improve spelling --- doc/conf.py | 9 ++++++++- doc/spelling_wordlist.txt | 10 +++++++++- doc/user/printers.rst | 2 +- src/escpos/escpos.py | 10 ++++++---- 4 files changed, 24 insertions(+), 7 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 3dac523..e10ac5e 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -316,8 +316,15 @@ spelling_ignore_pypi_package_names = True spelling_ignore_wiki_words = True spelling_ignore_python_builtins = True spelling_ignore_importable_modules = True +spelling_ignore_contributor_names = True spelling_word_list_filename = "spelling_wordlist.txt" spelling_show_suggestions = True spelling_suggestion_limit = 3 spelling_warning = True -spelling_exclude_patterns = ["**/capabilities.json*"] +spelling_exclude_patterns = [ + "**/capabilities.json", + "../../capabilities-data/dist/capabilities.json", + "**/available-encodings.rst", + "**/available-profiles.rst", + "dev/todo.rst", +] diff --git a/doc/spelling_wordlist.txt b/doc/spelling_wordlist.txt index 32eb779..c7c5741 100644 --- a/doc/spelling_wordlist.txt +++ b/doc/spelling_wordlist.txt @@ -1,5 +1,7 @@ ESC +Esc POS +Pos Escpos Escpos escpos @@ -7,9 +9,15 @@ escpos barcodes baudrate charcode +dev +dialout +ean +Ean lp lsusb printcap programmatically Raspbian -traceback \ No newline at end of file +Todo +traceback +udev \ No newline at end of file diff --git a/doc/user/printers.rst b/doc/user/printers.rst index 342d5d3..d9db0b9 100644 --- a/doc/user/printers.rst +++ b/doc/user/printers.rst @@ -12,7 +12,7 @@ printers. .. note:: This driver is not suited for USB-to-Serial-adapters - and similiar devices, but only for those implementing native USB. + and similar devices, but only for those implementing native USB. .. autoclass:: escpos.printer.Usb :members: diff --git a/src/escpos/escpos.py b/src/escpos/escpos.py index 4c2cfa9..8899efe 100644 --- a/src/escpos/escpos.py +++ b/src/escpos/escpos.py @@ -110,7 +110,7 @@ SW_BARCODE_NAMES = { class Escpos(object): """ESC/POS Printer object. - This class is the abstract base class for an esc/pos-printer. The printer implementations are children of this + This class is the abstract base class for an Esc/Pos-printer. The printer implementations are children of this class. """ @@ -391,9 +391,11 @@ class Escpos(object): def charcode(self, code: str = "AUTO") -> None: """Set Character Code Table. - Sets the control sequence from ``CHARCODE`` in :py:mod:`escpos.constants` as active. It will be sent with - the next text sequence. If you set the variable code to ``AUTO`` it will try to automatically guess the - right codepage. (This is the standard behaviour.) + Sets the control sequence from ``CHARCODE`` in :py:mod:`escpos.constants` as active. + It will be sent with the next text sequence. + If you set the variable code to ``AUTO`` it will try to automatically guess the + right codepage. + (This is the standard behavior.) :param code: Name of CharCode :raises: :py:exc:`~escpos.exceptions.CharCodeError`