Skip to content

Commit

Permalink
Minor documentation improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
WhyNotHugo committed Sep 20, 2023
1 parent 73afc4a commit 8ed1aa4
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/writers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,14 @@ be set).
Some barcode classes change the above defaults to fit in some kind
of specification.

BaseWriter
----------

Both ``ImageWriter`` and ``SVGWriter`` are subclasses of ``BaseWriter``:

.. autoclass:: barcode.writer.BaseWriter
:members:

SVGWriter
---------

Expand Down Expand Up @@ -90,7 +98,7 @@ In addition to the common writer options you can give the following special opti
Custom writers
--------------

It's possible to create your own writer by inheriting from `barcode.writer.BaseWriter`.
It's possible to create your own writer by inheriting from ``barcode.writer.BaseWriter``.

In your ``__init__`` method call BaseWriter's ``__init__`` and give your callbacks for:

Expand Down Expand Up @@ -122,5 +130,5 @@ Saving a compressed SVG (SVGZ):
>>> filename
'ean13.svgz'
Now you have ean13.svg and the compressed ean13.svgz in your current
Now you have ``ean13.svg`` and the compressed ``ean13.svgz`` in your current
working directory. Open it and see the result.

0 comments on commit 8ed1aa4

Please sign in to comment.