Skip to content

Commit

Permalink
Update font.rst
Browse files Browse the repository at this point in the history
Add some missing property documentation.
  • Loading branch information
JorjMcKie committed Oct 14, 2024
1 parent ad9c2e1 commit 9318132
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions docs/font.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,10 @@ A Font object also contains useful general information, like the font bbox, the
:attr:`~Font.flags` Collection of font properties
:attr:`~Font.glyph_count` Number of supported glyphs
:attr:`~Font.name` Name of font
:attr:`~Font.is_writable` Font usable with :ref:`TextWriter`
:attr:`~Font.is_bold` `True` if bold
:attr:`~Font.is_monospaced` `True` if mono-spaced
:attr:`~Font.is_serif` `True` if serif, `False` if sans-serif
:attr:`~Font.is_italic` `True` if italic
==================================== ============================================


Expand Down Expand Up @@ -349,18 +352,22 @@ A Font object also contains useful general information, like the font bbox, the

:rtype: float

.. attribute:: is_writable
.. attribute:: is_bold

* New in v1.18.0
.. attribute:: is_italic

.. attribute:: is_monospaced

.. attribute:: is_serif

Indicates whether this font can be used with :ref:`TextWriter`.
A number of attributes with obvious meanings. Reflect some values of the :attr:`Font.flags` dictionary.

:rtype: bool

.. rubric:: Footnotes

.. [#f1] MuPDF does not support all fontfiles with this feature and will raise exceptions like *"mupdf: FT_New_Memory_Face((null)): unknown file format"*, if it encounters issues. The :ref:`TextWriter` methods check :attr:`Font.is_writable`.
.. [#f1] MuPDF does not support all fontfiles with this feature and will raise exceptions like *"mupdf: FT_New_Memory_Face((null)): unknown file format"*, if it encounters issues.
.. [#f2] The built-in module *array* has been chosen for its speed and its compact representation of values.
.. [#f2] The built-in Python module `array` has been chosen for its speed and low memory requirement.
.. include:: footer.rst

0 comments on commit 9318132

Please sign in to comment.