matplotlib · NelleV · Dec 9, 2019 · Dec 9, 2019 · anntzer · Dec 9, 2019
diff --git a/examples/widgets/rectangle_selector.py b/examples/widgets/rectangle_selector.py
@@ -7,7 +7,7 @@
 the button.  This class gives click- and release-events and also draws
 a line or a box from the click-point to the actual mouseposition
 (within the same axes) until the button is released.  Within the
-method 'self.ignore()' it is checked whether the button from eventpress
+method ``self.ignore()`` it is checked whether the button from eventpress
 and eventrelease are the same.
 """
 from matplotlib.widgets import RectangleSelector

diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -228,7 +228,7 @@ def _set_labelrotation(self, labelrotation):
        self._labelrotation = (mode, angle)

    def apply_tickdir(self, tickdir):
-        """Calculate self._pad and self._tickmarkers."""
+        """Calculate ``self._pad`` and ``self._tickmarkers``."""

    def get_tickdir(self):
        return self._tickdir

diff --git a/lib/matplotlib/backend_tools.py b/lib/matplotlib/backend_tools.py
@@ -59,7 +59,7 @@ class ToolBase:
    Keymap to associate with this tool

    **String**: List of comma separated keys that will be used to call this
-    tool when the keypress event of *self.figure.canvas* is emitted
+    tool when the keypress event of ``self.figure.canvas`` is emitted
    """

    description = None
@@ -675,8 +675,8 @@ def _axes_pos(self, ax):

    def update_home_views(self, figure=None):
        """
-        Make sure that self.home_views has an entry for all axes present in the
-        figure
+        Make sure that ``self.home_views`` has an entry for all axes present
+        in the figure.
        """

        if not figure:

diff --git a/lib/matplotlib/backends/backend_pdf.py b/lib/matplotlib/backends/backend_pdf.py
@@ -682,7 +682,7 @@ def fontName(self, fontprop):
    def dviFontName(self, dvifont):
        """
        Given a dvi font object, return a name suitable for Op.selectfont.
-        This registers the font information in self.dviFontInfo if not yet
+        This registers the font information in ``self.dviFontInfo`` if not yet
        registered.
        """

@@ -2282,7 +2282,7 @@ def pop(self):
        return [Op.grestore]

    def clip_cmd(self, cliprect, clippath):
-        """Set clip rectangle. Calls self.pop() and self.push()."""
+        """Set clip rectangle. Calls `.pop()` and `.push()`."""
        cmds = []
        # Pop graphics state until we hit the right one or the stack is empty
        while ((self._cliprect, self._clippath) != (cliprect, clippath)

diff --git a/lib/matplotlib/colors.py b/lib/matplotlib/colors.py
@@ -646,7 +646,7 @@ def _set_extremes(self):
        self._lut[self._i_bad] = self._rgba_bad

    def _init(self):
-        """Generate the lookup table, self._lut"""
+        """Generate the lookup table, ``self._lut``."""
        raise NotImplementedError("Abstract class only")

    def is_gray(self):
@@ -983,9 +983,9 @@ def __call__(self, value, clip=None):
        """
        Normalize *value* data in the ``[vmin, vmax]`` interval into
        the ``[0.0, 1.0]`` interval and return it.  *clip* defaults
-        to *self.clip* (which defaults to *False*).  If not already
+        to ``self.clip`` (which defaults to *False*).  If not already
        initialized, *vmin* and *vmax* are initialized using
-        *autoscale_None(value)*.
+        ``autoscale_None(value)``.
        """
        if clip is None:
            clip = self.clip

diff --git a/lib/matplotlib/offsetbox.py b/lib/matplotlib/offsetbox.py
@@ -1078,7 +1078,7 @@ def __init__(self, loc,

        frameon : draw a frame box if True.

-        bbox_to_anchor : bbox to anchor. Use self.axes.bbox if None.
+        bbox_to_anchor : bbox to anchor. Use ``self.axes.bbox`` if None.

        bbox_transform : with which the bbox_to_anchor will be transformed.


diff --git a/lib/matplotlib/tests/test_transforms.py b/lib/matplotlib/tests/test_transforms.py
@@ -15,7 +15,7 @@ def test_non_affine_caching():
    class AssertingNonAffineTransform(mtransforms.Transform):
        """
        This transform raises an assertion error when called when it
-        shouldn't be and self.raise_on_transform is True.
+        shouldn't be and ``self.raise_on_transform`` is True.

        """
        input_dims = output_dims = 2

diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -1894,11 +1894,12 @@ def set_annotation_clip(self, b):
        Parameters
        ----------
        b : bool or None
-            - True: the annotation will only be drawn when self.xy is inside
-              the axes.
+            - True: the annotation will only be drawn when ``self.xy`` is
+              inside the axes.
            - False: the annotation will always be drawn regardless of its
              position.
-            - None: the self.xy will be checked only if *xycoords* is "data".
+            - None: the ``self.xy`` will be checked only if *xycoords* is
+              "data".
        """
        self._annotation_clip = b


diff --git a/lib/matplotlib/tri/triinterpolate.py b/lib/matplotlib/tri/triinterpolate.py
@@ -1245,7 +1245,7 @@ def __init__(self, vals, rows, cols, shape):
    def dot(self, V):
        """
        Dot product of self by a vector *V* in sparse-dense to dense format
-        *V* dense vector of shape (self.m,)
+        *V* dense vector of shape (self.m,).
        """
        assert V.shape == (self.m,)
        return np.bincount(self.rows,
-Original file line number
+Diff line change
@@ -7,7 +7,7 @@
     the button.  This class gives click- and release-events and also draws
     a line or a box from the click-point to the actual mouseposition
     (within the same axes) until the button is released.  Within the
-    method 'self.ignore()' it is checked whether the button from eventpress
+    method ``self.ignore()`` it is checked whether the button from eventpress
             Copy link

  
      
    
  

  
      

  
    Contributor


      

  

  
    
      

      
            anntzer
  

      

      

      


        Dec 9, 2019


      
  •

  
    
      
        
          edited
          
        
        
      
    
    
      
  
        
      Loading


  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  
    
  


    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      This should really be within :meth:`.ignore`, no?  (not that it really matters here as this is not an API doc, but still...).
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
  


          
          
        
      
    

    



    
        
  
    
        
    
  


      
          
  
      
            Copy link

  
      
    
  

  
      

  
  Member


      

  Author


  

  
    
      

      
            timhoffm
  

      

      

      


        Dec 9, 2019


      
    

  


        
      
  
  
  
    

    There was a problem hiding this comment.


  

 
  
    

    Choose a reason for hiding this comment

    
      The reason will be displayed to describe this comment to others. Learn more.
    

    
      
      


  


  
    
      Well, possibly. But there are multiple .ignore methods and I was too lazy to find out which one to link. IMHO it's good enough for now.
    
  
  


    

        
      
  
  
    
  
  
  
    
    Sorry, something went wrong.
  

  
    
  
    
      

              Uh oh!

              
There was an error while loading. Please reload this page.


  
  


          
      
  
    
    
      
        
            
    All reactions
     and eventrelease are the same.
     """
     from matplotlib.widgets import RectangleSelector
-          Expand Down