Skip to content

Document node label sizing in draw function #680

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
saikumarvasa100-hash wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document node label sizing in draw function #680

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion docs/source/api/drawing/xgi.drawing.draw.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,17 @@ xgi.drawing.draw
.. automodule:: xgi.drawing.draw

.. rubric:: Functions

.. note::

**Node Label Sizing**: The :func:`draw` function does not currently support
customizing the size of node labels. Node labels are drawn with default sizing.

If you need to customize node label properties (including size), you can draw
the hypergraph elements separately using :func:`draw_nodes` and then use
:func:`draw_node_labels` with custom matplotlib text properties. Alternatively,
you can use matplotlib's text manipulation functions directly on the drawn labels.


.. autofunction:: draw
.. autofunction:: draw_bipartite
Expand All @@ -16,4 +27,4 @@ xgi.drawing.draw
.. autofunction:: draw_directed_dyads
.. autofunction:: draw_simplices
.. autofunction:: draw_node_labels
.. autofunction:: draw_hyperedge_labels
.. autofunction:: draw_hyperedge_labels