Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 3bce52d

Browse files
committed
mend
1 parent 5cb6344 commit 3bce52d

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

doc/devel/contribute.rst

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -416,18 +416,21 @@ Variable names
416416
When feasible, please use our internal variable naming convention for objects
417417
of a given class and objects of any child class:
418418

419-
+---------------+------------------------------------+
420-
| variable name | base class |
421-
+===============+====================================+
422-
| ``fig`` | `~matplotlib.figure.FigureBase` |
423-
+---------------+------------------------------------+
424-
| ``ax`` | `~matplotlib.axes.Axes` |
425-
+---------------+------------------------------------+
426-
| ``trans`` | `~matplotlib.transforms.Transform` |
427-
+---------------+------------------------------------+
428-
429-
Generally, denote more than instance of the same class by adding numbers to
430-
the variable names, i.e. ``trans1``, ``trans2``.
419+
+------------------------------------+---------------+------------------------------------------+
420+
| base class | variable name | multiples |
421+
+====================================+===============+==========================================+
422+
| `~matplotlib.figure.FigureBase` | ``fig`` | |
423+
+------------------------------------+---------------+------------------------------------------+
424+
| `~matplotlib.axes.Axes` | ``ax`` | |
425+
+------------------------------------+---------------+------------------------------------------+
426+
| `~matplotlib.transforms.Transform` | ``trans`` | ``trans_<source>_<target>`` or |
427+
| | | ``trans_<source>`` when target is screen |
428+
+------------------------------------+---------------+------------------------------------------+
429+
430+
Generally, denote more than one instance of the same class by adding suffixes to
431+
the variable names. If a format isn't specified in the table, use numbers or
432+
letters as appropriate.
433+
431434

432435
.. _type-hints:
433436

@@ -495,13 +498,13 @@ ensure that a reference is included in the descriptive text.
495498

496499
API Change Notes
497500
""""""""""""""""
498-
.. include:: doc/api/next_api_changes/readme.rst
501+
.. include:: ../api/next_api_changes/README.rst
499502
:start-line: 5
500503
:end-line: 31
501504

502505
What's new
503506
""""""""""
504-
.. include:: doc/users/next_whats_new/readme.rst
507+
.. include:: ../users/next_whats_new/README.rst
505508
:start-line: 5
506509
:end-line: 24
507510

0 commit comments

Comments
 (0)