Skip to content

Commit 767edcc

Browse files
committed
Update docstring
1 parent 7950370 commit 767edcc

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

niceplots/utils.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -250,9 +250,8 @@ def draggable_legend(axis=None, color_on=True, **kwargs):
250250
def label_line_ends(ax, lines=None, labels=None, colors=None, x_offset_pts=6, y_offset_pts=0, **kwargs):
251251
"""Place a label just to the right of each line in the axes
252252
253-
Note: Because the labels are placed outside of the axes, this function works best for plots where all lines end as
254-
close to the right edge of the axes as possible. Additionally you need to either use constrained_layout=True
255-
(as NicePlots styles do), or call plt.tight_layout() after calling this function.
253+
Note: If any of the lines you are labelling go beyond the axis limits, make sure to call this function after setting
254+
the axis limits, otherwise the labels will not be placed correctly
256255
257256
Parameters
258257
----------

0 commit comments

Comments
 (0)