Add note about log axes

dstansby · dstansby · commit 49da75e46ccc · 2018-04-17T15:54:03.000+01:00
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -621,7 +621,7 @@ def axvline(self, x=0, ymin=0, ymax=1, **kwargs):
     @docstring.dedent_interpd
     def axline(self, slope, intercept, **kwargs):
         """
-        Add an infinite line across an axis.
+        Add an infinite straight line across an axis.
 
         Parameters
         ----------
@@ -644,15 +644,15 @@ def axline(self, slope, intercept, **kwargs):
 
         Examples
         --------
-        * draw a thick red line with slope 1 and y-intercept 0::
+        * Draw a thick red line with slope 1 and y-intercept 0::
 
             >>> axline(1, 0, linewidth=4, color='r')
 
-        * draw a default line with slope 1 and y-intercept 1::
+        * Draw a default line with slope 1 and y-intercept 1::
 
             >>> axline(1, 1)
 
-        * draw a default line with slope 5 and y-intercept 0::
+        * Draw a default line with slope 5 and y-intercept 0::
 
             >>> axline(5, 0)
 
@@ -661,6 +661,9 @@ def axline(self, slope, intercept, **kwargs):
         axhline : for horizontal lines
         axvline : for vertical lines
 
+        Notes
+        -----
+        Currently this method does not work properly with log scaled axes.
         """
 
         if "transform" in kwargs:
