Skip to content

Commit 8ed1aa4

Browse files
committed
Minor documentation improvements
1 parent 73afc4a commit 8ed1aa4

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

docs/writers.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,14 @@ be set).
5757
Some barcode classes change the above defaults to fit in some kind
5858
of specification.
5959

60+
BaseWriter
61+
----------
62+
63+
Both ``ImageWriter`` and ``SVGWriter`` are subclasses of ``BaseWriter``:
64+
65+
.. autoclass:: barcode.writer.BaseWriter
66+
:members:
67+
6068
SVGWriter
6169
---------
6270

@@ -90,7 +98,7 @@ In addition to the common writer options you can give the following special opti
9098
Custom writers
9199
--------------
92100

93-
It's possible to create your own writer by inheriting from `barcode.writer.BaseWriter`.
101+
It's possible to create your own writer by inheriting from ``barcode.writer.BaseWriter``.
94102

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

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

0 commit comments

Comments
 (0)