Skip to content

Commit e250a3a

Browse files
committed
Update shape.rst
1 parent 2a2a24a commit e250a3a

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

docs/shape.rst

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -620,15 +620,23 @@ Common Parameters
620620

621621
**miter_limit** (*float*)
622622

623-
A float specifying the maximum acceptable value of the quotient `(miter length) / (border line width)`. Used in text output methods, this is only relevant for non-zero render mode values -- then characters are written with border lines (i.e. "stroked"). If two lines stroking a character meet at a sharp (<= 90°) angle and the border line width is large enough, then "spikes" may become visible -- causing an ugly appearance. For visualization of this see page 126 of the :ref:`AdobeManual`. For instance, when joined lines meet at an angle of 90°, then the miter length is ``sqrt(2) * (border line width)``, so their miter quotient is ``sqrt(2)``. If ``miter_limit`` is exceeded, then all line joins meeting at a sharper angle will be appear as beveled ("butt" appearance). The default value 1 will ensure that line joins always appear as beveled. A value of ``None`` will cause a PDF default value.
623+
A float specifying the maximum acceptable value of the quotient `miter-length / line-width` ("miter quotient"). Used in text output methods. This is only relevant for non-zero render mode values -- then, characters are written with border lines (i.e. "stroked").
624+
625+
If two lines stroking some character meet at a sharp (<= 90°) angle and the line width is large enough, then "spikes" may become visible -- causing an ugly appearance as shown below. For more background, see page 126 of the :ref:`AdobeManual`.
626+
627+
For instance, when joins meet at 90°, then the miter length is ``sqrt(2) * line-width``, so the miter quotient is ``sqrt(2)``.
628+
629+
If ``miter_limit`` is exceeded, then all joins with a larger qotient will appear as beveled ("butt" appearance).
630+
631+
The default value 1 (and any smaller value) will ensure that all joins are rendered as a butt. A value of ``None`` will use the PDF default value.
624632

625633
Example text showing spikes (``miter_limit=None``):
626634

627-
.. image:: images/img-rendermode.*
635+
.. image:: images/spikes-yes.*
628636

629-
Example text suppressing spikes (``miter_limit=1``):
637+
Example text suppressing spikes (``miter_limit=1``):
630638

631-
.. image:: images/img-rendermode.*
639+
.. image:: images/spikes-no.*
632640

633641
----
634642

0 commit comments

Comments
 (0)