Skip to content

Commit

Permalink
Merge pull request #65 from colinmorris/only_move_doc
Browse files Browse the repository at this point in the history
Correct docstring description of only_move. Fixes #61.
  • Loading branch information
Phlya committed Sep 27, 2018
2 parents 8f5f02e + 8e2fca1 commit f91e878
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions adjustText/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -398,11 +398,11 @@ def adjust_text(texts, x=None, y=None, add_objects=None, ax=None,
and heights, respectively. May need to increase for complicated
situations; default 0.01
only_move (dict): a dict to restrict movement of texts to only certain
axis. Valid keys are 'points', 'text', and 'objects'. For each of
them valid values are 'x', 'y' and 'xy'. This way you can forbid
moving texts along either of the axes due to overlaps with points,
but let it happen if there is an overlap with texts:
only_move={'points':'y', 'text':'xy'}. Default: everything is allowed.
axes for certain types of overlaps. Valid keys are 'points', 'text',
and 'objects'. Valid values are '', 'x', 'y', and 'xy'.
For example, only_move={'points':'y', 'text':'xy', 'objects':'xy'}
forbids moving texts along the x axis due to overlaps with points.
Default: everything is allowed.
text_from_text (bool): whether to repel texts from each other; default
True
text_from_points (bool): whether to repel texts from points; default
Expand Down

0 comments on commit f91e878

Please sign in to comment.