-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathcontributing.html
More file actions
1223 lines (1035 loc) · 78.7 KB
/
contributing.html
File metadata and controls
1223 lines (1035 loc) · 78.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<title>Contributing — Matplotlib 3.6.3 documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
</script>
<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=796348d33e8b1d947c94" rel="stylesheet">
<link href="../_static/styles/bootstrap.css?digest=796348d33e8b1d947c94" rel="stylesheet">
<link href="../_static/styles/pydata-sphinx-theme.css?digest=796348d33e8b1d947c94" rel="stylesheet">
<link href="../_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=796348d33e8b1d947c94" rel="stylesheet">
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2">
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v3.6.3-3-g655f616e86" />
<link rel="stylesheet" type="text/css" href="../_static/css/style.css?v3.6.3-3-g655f616e86" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v3.6.3-3-g655f616e86" />
<link rel="stylesheet" type="text/css" href="../_static/plot_directive.css?v3.6.3-3-g655f616e86" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v3.6.3-3-g655f616e86" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery.css?v3.6.3-3-g655f616e86" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-binder.css?v3.6.3-3-g655f616e86" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-dataframe.css?v3.6.3-3-g655f616e86" />
<link rel="stylesheet" type="text/css" href="../_static/sg_gallery-rendered-html.css?v3.6.3-3-g655f616e86" />
<link rel="stylesheet" type="text/css" href="../_static/design-style.4045f2051d55cab465a707391d5b2007.min.css?v3.6.3-3-g655f616e86" />
<link rel="stylesheet" type="text/css" href="../_static/mpl.css?v3.6.3-3-g655f616e86" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=796348d33e8b1d947c94">
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=796348d33e8b1d947c94">
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v3.6.3-3-g655f616e86"></script>
<script src="../_static/jquery.js?v3.6.3-3-g655f616e86"></script>
<script src="../_static/underscore.js?v3.6.3-3-g655f616e86"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v3.6.3-3-g655f616e86"></script>
<script src="../_static/doctools.js?v3.6.3-3-g655f616e86"></script>
<script src="../_static/sphinx_highlight.js?v3.6.3-3-g655f616e86"></script>
<script src="../_static/clipboard.min.js?v3.6.3-3-g655f616e86"></script>
<script src="../_static/copybutton.js?v3.6.3-3-g655f616e86"></script>
<script src="../_static/design-tabs.js?v3.6.3-3-g655f616e86"></script>
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'devel/contributing';</script>
<script>
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://matplotlib.org/devdocs/_static/switcher.json';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '3.6.3';
</script>
<link rel="canonical" href="https://matplotlib.org/stable/devel/contributing.html" />
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 3.6.3 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Bug triaging and issue curation" href="triage.html" />
<link rel="prev" title="Contributing" href="index.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en">
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="180" data-default-mode="">
<a class="skip-link" href="#main-content">Skip to main content</a>
<input type="checkbox" class="sidebar-toggle" name="__primary" id="__primary">
<label class="overlay overlay-primary" for="__primary"></label>
<input type="checkbox" class="sidebar-toggle" name="__secondary" id="__secondary">
<label class="overlay overlay-secondary" for="__secondary"></label>
<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form class="bd-search d-flex align-items-center" action="../search.html" method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false">
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</div>
</div>
<nav class="bd-header navbar navbar-expand-lg bd-navbar" id="navbar-main"><div class="bd-header__inner bd-page-width">
<label class="sidebar-toggle primary-toggle" for="__primary">
<span class="fa-solid fa-bars"></span>
</label>
<div id="navbar-start">
<a class="navbar-brand logo" href="../index.html">
<img src="../_static/images/logo2.svg" class="logo__image only-light" alt="Logo image">
<img src="../_static/images/logo_dark.svg" class="logo__image only-dark" alt="Logo image">
</a>
</div>
<div class="col-lg-9 navbar-header-items">
<div id="navbar-center" class="mr-auto">
<div class="navbar-center-item">
<ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="../plot_types/index.html">Plot types</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../gallery/index.html">Examples</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../tutorials/index.html">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../api/index.html">Reference</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/index.html">User guide</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="index.html">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/release_notes.html">Release notes</a>
</li>
</ul>
</div>
</div>
<div id="navbar-end">
<div class="navbar-end-item navbar-persistent--container">
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
</button>
</div>
<div class="navbar-end-item">
<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-toggle="tooltip">
<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
</button>
</div>
<div class="navbar-end-item">
<div class="version-switcher__container dropdown">
<button type="button" class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" data-toggle="dropdown">
stable <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div class="version-switcher__menu dropdown-menu list-group-flush py-0">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div>
</div>
<div class="navbar-end-item">
<ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a href="https://gitter.im/matplotlib/matplotlib" title="Gitter" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fab fa-gitter"></i></span>
<label class="sr-only">Gitter</label></a>
</li>
<li class="nav-item">
<a href="https://discourse.matplotlib.org" title="Discourse" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fab fa-discourse"></i></span>
<label class="sr-only">Discourse</label></a>
</li>
<li class="nav-item">
<a href="https://github.com/matplotlib/matplotlib" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fab fa-github"></i></span>
<label class="sr-only">GitHub</label></a>
</li>
<li class="nav-item">
<a href="https://twitter.com/matplotlib/" title="Twitter" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fab fa-twitter"></i></span>
<label class="sr-only">Twitter</label></a>
</li>
</ul>
</div>
</div>
</div>
<div class="navbar-persistent--mobile">
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
</button>
</div>
<label class="sidebar-toggle secondary-toggle" for="__secondary">
<span class="fa-solid fa-outdent"></span>
</label>
</div>
</nav>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<div class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-center-item">
<ul id="navbar-main-elements" class="navbar-nav">
<li class="nav-item">
<a class="reference internal nav-link" href="../plot_types/index.html">Plot types</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../gallery/index.html">Examples</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../tutorials/index.html">Tutorials</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../api/index.html">Reference</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/index.html">User guide</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="index.html">Develop</a>
</li>
<li class="nav-item">
<a class="reference internal nav-link" href="../users/release_notes.html">Release notes</a>
</li>
</ul>
</div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-end-item">
<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-toggle="tooltip">
<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
</button>
</div>
<div class="navbar-end-item">
<div class="version-switcher__container dropdown">
<button type="button" class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" data-toggle="dropdown">
stable <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div class="version-switcher__menu dropdown-menu list-group-flush py-0">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div>
</div>
<div class="navbar-end-item">
<ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
<li class="nav-item">
<a href="https://gitter.im/matplotlib/matplotlib" title="Gitter" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fab fa-gitter"></i></span>
<label class="sr-only">Gitter</label></a>
</li>
<li class="nav-item">
<a href="https://discourse.matplotlib.org" title="Discourse" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fab fa-discourse"></i></span>
<label class="sr-only">Discourse</label></a>
</li>
<li class="nav-item">
<a href="https://github.com/matplotlib/matplotlib" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fab fa-github"></i></span>
<label class="sr-only">GitHub</label></a>
</li>
<li class="nav-item">
<a href="https://twitter.com/matplotlib/" title="Twitter" class="nav-link" rel="noopener" target="_blank" data-toggle="tooltip"><span><i class="fab fa-twitter"></i></span>
<label class="sr-only">Twitter</label></a>
</li>
</ul>
</div>
</div>
</div>
<div class="sidebar-start-items sidebar-primary__section">
<div class="sidebar-start-items__item"><nav class="bd-links" id="bd-docs-nav" aria-label="Section navigation">
<p class="bd-links__title" role="heading" aria-level="1">
Section Navigation
</p>
<div class="bd-toc-item navbar-nav">
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Contributing</a></li>
<li class="toctree-l1"><a class="reference internal" href="triage.html">Bug triaging and issue curation</a></li>
<li class="toctree-l1"><a class="reference internal" href="development_setup.html">Setting up Matplotlib for development</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="documenting_mpl.html">Writing documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="style_guide.html">Documentation style guide</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="gitwash/index.html">Working with <em>Matplotlib</em> source code</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="gitwash/git_intro.html">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="gitwash/git_install.html">Install git</a></li>
<li class="toctree-l2"><a class="reference internal" href="gitwash/following_latest.html">Following the latest source</a></li>
<li class="toctree-l2"><a class="reference internal" href="gitwash/patching.html">Making a patch</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="gitwash/git_development.html">Git for development</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="gitwash/forking_hell.html">Making your own copy (fork) of Matplotlib</a></li>
<li class="toctree-l3"><a class="reference internal" href="gitwash/set_up_fork.html">Set up your fork</a></li>
<li class="toctree-l3"><a class="reference internal" href="gitwash/configure_git.html">Configure git</a></li>
<li class="toctree-l3"><a class="reference internal" href="gitwash/development_workflow.html">Development workflow</a></li>
<li class="toctree-l3"><a class="reference internal" href="gitwash/maintainer_workflow.html">Maintainer workflow</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="gitwash/git_resources.html">git resources</a></li>
<li class="toctree-l2"><a class="reference internal" href="gitwash/dot2_dot3.html">Two and three dots in difference specs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="coding_guide.html">Pull request guidelines</a></li>
<li class="toctree-l1"><a class="reference internal" href="release_guide.html">Release guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="min_dep_policy.html">Minimum version of dependencies policy</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="MEP/index.html">Matplotlib Enhancement Proposals</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="MEP/template.html">MEP Template</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP08.html">MEP8: PEP8</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP09.html">MEP9: Global interaction manager</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP10.html">MEP10: Docstring consistency</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP11.html">MEP11: Third-party dependencies</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP12.html">MEP12: Improve Gallery and Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP13.html">MEP13: Use properties for Artists</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP14.html">MEP14: Text handling</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP15.html">MEP15: Fix axis autoscaling when limits are specified for one axis only</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP19.html">MEP19: Continuous Integration</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP21.html">MEP21: color and cm refactor</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP22.html">MEP22: Toolbar rewrite</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP23.html">MEP23: Multiple Figures per GUI window</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP24.html">MEP24: Negative radius in polar plots</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP25.html">MEP25: Serialization</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP26.html">MEP26: Artist styling</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP27.html">MEP27: Decouple pyplot from backends</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP28.html">MEP28: Remove Complexity from Axes.boxplot</a></li>
<li class="toctree-l2"><a class="reference internal" href="MEP/MEP29.html">MEP29: Text light markup</a></li>
</ul>
</li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="license.html">Licenses</a></li>
<li class="toctree-l1"><a class="reference internal" href="color_changes.html">Default color changes</a></li>
</ul>
</div>
</nav>
</div>
</div>
<div class="sidebar-end-items sidebar-primary__section">
<div class="sidebar-end-items__item">
</div>
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article">
</div>
<article class="bd-article" role="main">
<section id="contributing">
<span id="id1"></span><h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this heading">#</a></h1>
<p>This project is a community effort, and everyone is welcome to
contribute. Everyone within the community
is expected to abide by our
<a class="reference external" href="https://github.com/matplotlib/matplotlib/blob/main/CODE_OF_CONDUCT.md">code of conduct</a>.</p>
<p>The project is hosted on
<a class="github reference external" href="https://github.com/matplotlib/matplotlib">matplotlib/matplotlib</a></p>
<section id="get-connected">
<h2>Get Connected<a class="headerlink" href="#get-connected" title="Permalink to this heading">#</a></h2>
<section id="do-i-really-have-something-to-contribute-to-matplotlib">
<h3>Do I really have something to contribute to Matplotlib?<a class="headerlink" href="#do-i-really-have-something-to-contribute-to-matplotlib" title="Permalink to this heading">#</a></h3>
<p>100% yes. There are so many ways to contribute to our community.</p>
<p>When in doubt, we recommend going together! Get connected with our community of
active contributors, many of whom felt just like you when they started out and
are happy to welcome you and support you as you get to know how we work, and
where things are. Take a look at the next sections to learn more.</p>
</section>
<section id="contributor-incubator">
<h3>Contributor incubator<a class="headerlink" href="#contributor-incubator" title="Permalink to this heading">#</a></h3>
<p>The incubator is our non-public communication channel for new contributors. It
is a private gitter room moderated by core Matplotlib developers where you can
get guidance and support for your first few PRs. It's a place you can ask
questions about anything: how to use git, github, how our PR review process
works, technical questions about the code, what makes for good documentation
or a blog post, how to get involved in community work, or get
"pre-review" on your PR.</p>
<p>To join, please go to our public <a class="reference external" href="https://gitter.im/matplotlib/matplotlib">gitter</a> community channel, and ask to be
added to '#incubator'. One of our core developers will see your message and will
add you.</p>
</section>
<section id="new-contributors-meeting">
<h3>New Contributors meeting<a class="headerlink" href="#new-contributors-meeting" title="Permalink to this heading">#</a></h3>
<p>Once a month, we host a meeting to discuss topics that interest new
contributors. Anyone can attend, present, or sit in and listen to the call.
Among our attendees are fellow new contributors, as well as maintainers, and
veteran contributors, who are keen to support onboarding of new folks and
share their experience. You can find our community calendar link at the
<a class="reference external" href="https://scientific-python.org/calendars/">Scientific Python website</a>, and
you can browse previous meeting notes on <a class="reference external" href="https://github.com/matplotlib/ProjectManagement/tree/master/new_contributor_meeting">github</a>.
We recommend joining the meeting to clarify any doubts, or lingering
questions you might have, and to get to know a few of the people behind the
GitHub handles 😉. You can reach out to @noatamir on <a class="reference external" href="https://gitter.im/matplotlib/matplotlib">gitter</a> for any clarifications or
suggestions. We <3 feedback!</p>
</section>
<section id="issues-for-new-contributors">
<span id="new-contributors"></span><h3>Issues for new contributors<a class="headerlink" href="#issues-for-new-contributors" title="Permalink to this heading">#</a></h3>
<p>While any contributions are welcome, we have marked some issues as
particularly suited for new contributors by the label <a class="reference external" href="https://github.com/matplotlib/matplotlib/labels/good%20first%20issue">good first issue</a>. These
are well documented issues, that do not require a deep understanding of the
internals of Matplotlib. The issues may additionally be tagged with a
difficulty. <code class="docutils literal notranslate"><span class="pre">Difficulty:</span> <span class="pre">Easy</span></code> is suited for people with little Python
experience. <code class="docutils literal notranslate"><span class="pre">Difficulty:</span> <span class="pre">Medium</span></code> and <code class="docutils literal notranslate"><span class="pre">Difficulty:</span> <span class="pre">Hard</span></code> require more
programming experience. This could be for a variety of reasons, among them,
though not necessarily all at the same time:</p>
<ul class="simple">
<li><p>The issue is in areas of the code base which have more interdependencies,
or legacy code.</p></li>
<li><p>It has less clearly defined tasks, which require some independent
exploration, making suggestions, or follow-up discussions to clarify a good
path to resolve the issue.</p></li>
<li><p>It involves Python features such as decorators and context managers, which
have subtleties due to our implementation decisions.</p></li>
</ul>
<p>In general, the Matplotlib project does not assign issues. Issues are
"assigned" or "claimed" by opening a PR; there is no other assignment
mechanism. If you have opened such a PR, please comment on the issue thread to
avoid duplication of work. Please check if there is an existing PR for the
issue you are addressing. If there is, try to work with the author by
submitting reviews of their code or commenting on the PR rather than opening
a new PR; duplicate PRs are subject to being closed. However, if the existing
PR is an outline, unlikely to work, or stalled, and the original author is
unresponsive, feel free to open a new PR referencing the old one.</p>
</section>
</section>
<section id="submitting-a-bug-report">
<span id="id3"></span><h2>Submitting a bug report<a class="headerlink" href="#submitting-a-bug-report" title="Permalink to this heading">#</a></h2>
<p>If you find a bug in the code or documentation, do not hesitate to submit a
ticket to the
<a class="reference external" href="https://github.com/matplotlib/matplotlib/issues">Issue Tracker</a>. You are
also welcome to post feature requests or pull requests.</p>
<p>If you are reporting a bug, please do your best to include the following:</p>
<ol class="arabic">
<li><p>A short, top-level summary of the bug. In most cases, this should be 1-2
sentences.</p></li>
<li><p>A short, self-contained code snippet to reproduce the bug, ideally allowing
a simple copy and paste to reproduce. Please do your best to reduce the code
snippet to the minimum required.</p></li>
<li><p>The actual outcome of the code snippet.</p></li>
<li><p>The expected outcome of the code snippet.</p></li>
<li><p>The Matplotlib version, Python version and platform that you are using. You
can grab the version with the following commands:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">matplotlib</span>
<span class="gp">>>> </span><span class="n">matplotlib</span><span class="o">.</span><span class="n">__version__</span>
<span class="go">'3.4.1'</span>
<span class="gp">>>> </span><span class="kn">import</span> <span class="nn">platform</span>
<span class="gp">>>> </span><span class="n">platform</span><span class="o">.</span><span class="n">python_version</span><span class="p">()</span>
<span class="go">'3.9.2'</span>
</pre></div>
</div>
</li>
</ol>
<p>We have preloaded the issue creation page with a Markdown form that you can
use to organize this information.</p>
<p>Thank you for your help in keeping bug reports complete, targeted and descriptive.</p>
</section>
<section id="requesting-a-new-feature">
<span id="request-a-new-feature"></span><h2>Requesting a new feature<a class="headerlink" href="#requesting-a-new-feature" title="Permalink to this heading">#</a></h2>
<p>Please post feature requests to the
<a class="reference external" href="https://github.com/matplotlib/matplotlib/issues">Issue Tracker</a>.</p>
<p>The Matplotlib developers will give feedback on the feature proposal. Since
Matplotlib is an open source project with limited resources, we encourage
users to then also
<a class="reference internal" href="#contributing-code"><span class="std std-ref">participate in the implementation</span></a>.</p>
</section>
<section id="contributing-code">
<span id="id5"></span><h2>Contributing code<a class="headerlink" href="#contributing-code" title="Permalink to this heading">#</a></h2>
<section id="how-to-contribute">
<span id="id6"></span><h3>How to contribute<a class="headerlink" href="#how-to-contribute" title="Permalink to this heading">#</a></h3>
<p>The preferred way to contribute to Matplotlib is to fork the <a class="reference external" href="https://github.com/matplotlib/matplotlib/">main
repository</a> on GitHub,
then submit a "pull request" (PR).</p>
<p>A brief overview is:</p>
<ol class="arabic">
<li><p><a class="reference external" href="https://github.com/join">Create an account</a> on GitHub if you do not
already have one.</p></li>
<li><p>Fork the <a class="reference external" href="https://github.com/matplotlib/matplotlib">project repository</a>:
click on the 'Fork' button near the top of the page. This creates a copy of
the code under your account on the GitHub server.</p></li>
<li><p>Clone this copy to your local disk:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/<</span><span class="n">YOUR</span> <span class="n">GITHUB</span> <span class="n">USERNAME</span><span class="o">>/</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">git</span>
</pre></div>
</div>
</li>
<li><p>Enter the directory and install the local version of Matplotlib.
See <a class="reference internal" href="development_setup.html#installing-for-devs"><span class="std std-ref">Setting up Matplotlib for development</span></a> for instructions</p></li>
<li><p>Create a branch to hold your changes:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">checkout</span> <span class="o">-</span><span class="n">b</span> <span class="n">my</span><span class="o">-</span><span class="n">feature</span> <span class="n">origin</span><span class="o">/</span><span class="n">main</span>
</pre></div>
</div>
<p>and start making changes. Never work in the <code class="docutils literal notranslate"><span class="pre">main</span></code> branch!</p>
</li>
<li><p>Work on this copy, on your computer, using Git to do the version control.
When you're done editing e.g., <code class="docutils literal notranslate"><span class="pre">lib/matplotlib/collections.py</span></code>, do:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">add</span> <span class="n">lib</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">/</span><span class="n">collections</span><span class="o">.</span><span class="n">py</span>
<span class="n">git</span> <span class="n">commit</span>
</pre></div>
</div>
<p>to record your changes in Git, then push them to GitHub with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">push</span> <span class="o">-</span><span class="n">u</span> <span class="n">origin</span> <span class="n">my</span><span class="o">-</span><span class="n">feature</span>
</pre></div>
</div>
</li>
</ol>
<p>Finally, go to the web page of your fork of the Matplotlib repo, and click
'Pull request' to send your changes to the maintainers for review.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<ul class="simple">
<li><p><a class="reference external" href="https://git-scm.com/doc">Git documentation</a></p></li>
<li><p><a class="reference external" href="https://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project">Git-Contributing to a Project</a></p></li>
<li><p><a class="reference external" href="https://lab.github.com/githubtraining/introduction-to-github">Introduction to GitHub</a></p></li>
<li><p><a class="reference internal" href="gitwash/development_workflow.html#development-workflow"><span class="std std-ref">Development workflow</span></a> for best practices for Matplotlib</p></li>
<li><p><a class="reference internal" href="gitwash/index.html#using-git"><span class="std std-ref">Working with Matplotlib source code</span></a></p></li>
</ul>
</div>
</section>
<section id="contributing-pull-requests">
<h3>Contributing pull requests<a class="headerlink" href="#contributing-pull-requests" title="Permalink to this heading">#</a></h3>
<p>It is recommended to check that your contribution complies with the following
rules before submitting a pull request:</p>
<ul>
<li><p>If your pull request addresses an issue, please use the title to describe the
issue and mention the issue number in the pull request description to ensure
that a link is created to the original issue.</p></li>
<li><p>All public methods should have informative docstrings with sample usage when
appropriate. Use the <a class="reference external" href="https://numpydoc.readthedocs.io/en/latest/format.html">numpy docstring standard</a>.</p></li>
<li><p>Formatting should follow the recommendations of <a class="reference external" href="https://www.python.org/dev/peps/pep-0008/">PEP8</a>, as enforced by
<a class="reference external" href="https://flake8.pycqa.org/">flake8</a>. You can check flake8 compliance from the command line with</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">pip</span> <span class="n">install</span> <span class="n">flake8</span>
<span class="n">flake8</span> <span class="o">/</span><span class="n">path</span><span class="o">/</span><span class="n">to</span><span class="o">/</span><span class="n">module</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
<p>or your editor may provide integration with it. Note that Matplotlib
intentionally does not use the <a class="reference external" href="https://black.readthedocs.io/">black</a> auto-formatter (<a class="reference external" href="https://github.com/matplotlib/matplotlib/issues/18796">1</a>), in particular due
to its unability to understand the semantics of mathematical expressions
(<a class="reference external" href="https://github.com/psf/black/issues/148">2</a>, <a class="reference external" href="https://github.com/psf/black/issues/1984">3</a>).</p>
</li>
<li><p>Each high-level plotting function should have a simple example in the
<code class="docutils literal notranslate"><span class="pre">Example</span></code> section of the docstring. This should be as simple as possible
to demonstrate the method. More complex examples should go in the
<code class="docutils literal notranslate"><span class="pre">examples</span></code> tree.</p></li>
<li><p>Changes (both new features and bugfixes) should have good test coverage. See
<a class="reference internal" href="testing.html#testing"><span class="std std-ref">Testing</span></a> for more details.</p></li>
<li><p>Import the following modules using the standard scipy conventions:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">numpy.ma</span> <span class="k">as</span> <span class="nn">ma</span>
<span class="kn">import</span> <span class="nn">matplotlib</span> <span class="k">as</span> <span class="nn">mpl</span>
<span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
<span class="kn">import</span> <span class="nn">matplotlib.cbook</span> <span class="k">as</span> <span class="nn">cbook</span>
<span class="kn">import</span> <span class="nn">matplotlib.patches</span> <span class="k">as</span> <span class="nn">mpatches</span>
</pre></div>
</div>
<p>In general, Matplotlib modules should <strong>not</strong> import <a class="reference internal" href="../api/matplotlib_configuration_api.html#matplotlib.rcParams" title="matplotlib.rcParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rcParams</span></code></a> using <code class="docutils literal notranslate"><span class="pre">from</span>
<span class="pre">matplotlib</span> <span class="pre">import</span> <span class="pre">rcParams</span></code>, but rather access it as <code class="docutils literal notranslate"><span class="pre">mpl.rcParams</span></code>. This
is because some modules are imported very early, before the <a class="reference internal" href="../api/matplotlib_configuration_api.html#matplotlib.rcParams" title="matplotlib.rcParams"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rcParams</span></code></a>
singleton is constructed.</p>
</li>
<li><p>If your change is a major new feature, add an entry to the <code class="docutils literal notranslate"><span class="pre">What's</span> <span class="pre">new</span></code>
section by adding a new file in <code class="docutils literal notranslate"><span class="pre">doc/users/next_whats_new</span></code> (see
<code class="file docutils literal notranslate"><span class="pre">doc/users/next_whats_new/README.rst</span></code> for more information).</p></li>
<li><p>If you change the API in a backward-incompatible way, please document it in
<code class="file docutils literal notranslate"><span class="pre">doc/api/next_api_changes/behavior</span></code>, by adding a new file with the
naming convention <code class="docutils literal notranslate"><span class="pre">99999-ABC.rst</span></code> where the pull request number is followed
by the contributor's initials. (see <code class="file docutils literal notranslate"><span class="pre">doc/api/api_changes.rst</span></code> for more
information)</p></li>
<li><p>See below for additional points about <a class="reference internal" href="#keyword-argument-processing"><span class="std std-ref">Keyword argument processing</span></a>, if
applicable for your pull request.</p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The current state of the Matplotlib code base is not compliant with all
of those guidelines, but we expect that enforcing those constraints on all
new contributions will move the overall code base quality in the right
direction.</p>
</div>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<ul class="simple">
<li><p><a class="reference internal" href="#coding-guidelines"><span class="std std-ref">Coding guidelines</span></a></p></li>
<li><p><a class="reference internal" href="testing.html#testing"><span class="std std-ref">Testing</span></a></p></li>
<li><p><a class="reference internal" href="documenting_mpl.html#documenting-matplotlib"><span class="std std-ref">Writing documentation</span></a></p></li>
</ul>
</div>
</section>
</section>
<section id="contributing-documentation">
<span id="id10"></span><h2>Contributing documentation<a class="headerlink" href="#contributing-documentation" title="Permalink to this heading">#</a></h2>
<p>You as an end-user of Matplotlib can make a valuable contribution because you
more clearly see the potential for improvement than a core developer. For example, you can:</p>
<ul class="simple">
<li><p>Fix a typo</p></li>
<li><p>Clarify a docstring</p></li>
<li><p>Write or update an <a class="reference internal" href="../gallery/index.html#gallery"><span class="std std-ref">example plot</span></a></p></li>
<li><p>Write or update a comprehensive <a class="reference internal" href="../tutorials/index.html#tutorials"><span class="std std-ref">tutorial</span></a></p></li>
</ul>
<p>The documentation source files live in the same GitHub repository as the code.
Contributions are proposed and accepted through the pull request process.
For details see <a class="reference internal" href="#how-to-contribute"><span class="std std-ref">How to contribute</span></a>.</p>
<p>If you have trouble getting started, you may instead open an <a class="reference external" href="https://github.com/matplotlib/matplotlib/issues">issue</a>
describing the intended improvement.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<ul class="simple">
<li><p><a class="reference internal" href="documenting_mpl.html#documenting-matplotlib"><span class="std std-ref">Writing documentation</span></a></p></li>
</ul>
</div>
</section>
<section id="other-ways-to-contribute">
<span id="id11"></span><h2>Other ways to contribute<a class="headerlink" href="#other-ways-to-contribute" title="Permalink to this heading">#</a></h2>
<p>It also helps us if you spread the word: reference the project from your blog
and articles or link to it from your website! If Matplotlib contributes to a
project that leads to a scientific publication, please follow the
<a class="reference internal" href="../users/project/citing.html"><span class="doc">Citing Matplotlib</span></a> guidelines.</p>
</section>
<section id="coding-guidelines">
<span id="id12"></span><h2>Coding guidelines<a class="headerlink" href="#coding-guidelines" title="Permalink to this heading">#</a></h2>
<section id="api-changes">
<h3>API changes<a class="headerlink" href="#api-changes" title="Permalink to this heading">#</a></h3>
<p>API consistency and stability are of great value. Therefore, API changes
(e.g. signature changes, behavior changes, removals) will only be conducted
if the added benefit is worth the user effort for adapting.</p>
<p>Because we are a visualization library our primary output is the final
visualization the user sees. Thus it is our <a class="reference internal" href="color_changes.html#color-changes"><span class="std std-ref">long standing</span></a> policy that the appearance of the figure is part of the API
and any changes, either semantic or esthetic, will be treated as a
backwards-incompatible API change.</p>
<p>API changes in Matplotlib have to be performed following the deprecation process
below, except in very rare circumstances as deemed necessary by the development team.
This ensures that users are notified before the change will take effect and thus
prevents unexpected breaking of code.</p>
<section id="rules">
<h4>Rules<a class="headerlink" href="#rules" title="Permalink to this heading">#</a></h4>
<ul class="simple">
<li><p>Deprecations are targeted at the next point.release (e.g. 3.x)</p></li>
<li><p>Deprecated API is generally removed two point-releases after introduction
of the deprecation. Longer deprecations can be imposed by core developers on
a case-by-case basis to give more time for the transition</p></li>
<li><p>The old API must remain fully functional during the deprecation period</p></li>
<li><p>If alternatives to the deprecated API exist, they should be available
during the deprecation period</p></li>
<li><p>If in doubt, decisions about API changes are finally made by the
API consistency lead developer</p></li>
</ul>
</section>
<section id="introducing">
<h4>Introducing<a class="headerlink" href="#introducing" title="Permalink to this heading">#</a></h4>
<ol class="arabic">
<li><p>Announce the deprecation in a new file
<code class="file docutils literal notranslate"><span class="pre">doc/api/next_api_changes/deprecations/99999-ABC.rst</span></code> where <code class="docutils literal notranslate"><span class="pre">99999</span></code>
is the pull request number and <code class="docutils literal notranslate"><span class="pre">ABC</span></code> are the contributor's initials.</p></li>
<li><p>If possible, issue a <a class="reference internal" href="../api/matplotlib_configuration_api.html#matplotlib.MatplotlibDeprecationWarning" title="matplotlib.MatplotlibDeprecationWarning"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MatplotlibDeprecationWarning</span></code></a> when the
deprecated API is used. There are a number of helper tools for this:</p>
<ul class="simple">
<li><p>Use <code class="docutils literal notranslate"><span class="pre">_api.warn_deprecated()</span></code> for general deprecation warnings</p></li>
<li><p>Use the decorator <code class="docutils literal notranslate"><span class="pre">@_api.deprecated</span></code> to deprecate classes, functions,
methods, or properties</p></li>
<li><p>To warn on changes of the function signature, use the decorators
<code class="docutils literal notranslate"><span class="pre">@_api.delete_parameter</span></code>, <code class="docutils literal notranslate"><span class="pre">@_api.rename_parameter</span></code>, and
<code class="docutils literal notranslate"><span class="pre">@_api.make_keyword_only</span></code></p></li>
</ul>
<p>All these helpers take a first parameter <em>since</em>, which should be set to
the next point release, e.g. "3.x".</p>
<p>You can use standard rst cross references in <em>alternative</em>.</p>
</li>
</ol>
</section>
<section id="expiring">
<h4>Expiring<a class="headerlink" href="#expiring" title="Permalink to this heading">#</a></h4>
<ol class="arabic simple">
<li><p>Announce the API changes in a new file
<code class="file docutils literal notranslate"><span class="pre">doc/api/next_api_changes/[kind]/99999-ABC.rst</span></code> where <code class="docutils literal notranslate"><span class="pre">99999</span></code>
is the pull request number and <code class="docutils literal notranslate"><span class="pre">ABC</span></code> are the contributor's initials, and
<code class="docutils literal notranslate"><span class="pre">[kind]</span></code> is one of the folders <code class="file docutils literal notranslate"><span class="pre">behavior</span></code>, <code class="file docutils literal notranslate"><span class="pre">development</span></code>,
<code class="file docutils literal notranslate"><span class="pre">removals</span></code>. See <code class="file docutils literal notranslate"><span class="pre">doc/api/next_api_changes/README.rst</span></code> for more
information. For the content, you can usually copy the deprecation notice
and adapt it slightly.</p></li>
<li><p>Change the code functionality and remove any related deprecation warnings.</p></li>
</ol>
</section>
</section>
<section id="adding-new-api">
<h3>Adding new API<a class="headerlink" href="#adding-new-api" title="Permalink to this heading">#</a></h3>
<p>Every new function, parameter and attribute that is not explicitly marked as
private (i.e., starts with an underscore) becomes part of Matplotlib's public
API. As discussed above, changing the existing API is cumbersome. Therefore,
take particular care when adding new API:</p>
<ul class="simple">
<li><p>Mark helper functions and internal attributes as private by prefixing them
with an underscore.</p></li>
<li><p>Carefully think about good names for your functions and variables.</p></li>
<li><p>Try to adopt patterns and naming conventions from existing parts of the
Matplotlib API.</p></li>
<li><p>Consider making as many arguments keyword-only as possible. See also
<a class="reference external" href="https://emptysqua.re/blog/api-evolution-the-right-way/#adding-parameters">API Evolution the Right Way -- Add Parameters Compatibly</a>.</p>
</li>
</ul>
</section>
<section id="new-modules-and-files-installation">
<h3>New modules and files: installation<a class="headerlink" href="#new-modules-and-files-installation" title="Permalink to this heading">#</a></h3>
<ul class="simple">
<li><p>If you have added new files or directories, or reorganized existing
ones, make sure the new files are included in the match patterns in
in <em>package_data</em> in <code class="file docutils literal notranslate"><span class="pre">setupext.py</span></code>.</p></li>
</ul>
</section>
<section id="c-c-extensions">
<h3>C/C++ extensions<a class="headerlink" href="#c-c-extensions" title="Permalink to this heading">#</a></h3>
<ul class="simple">
<li><p>Extensions may be written in C or C++.</p></li>
<li><p>Code style should conform to PEP7 (understanding that PEP7 doesn't
address C++, but most of its admonitions still apply).</p></li>
<li><p>Python/C interface code should be kept separate from the core C/C++
code. The interface code should be named <code class="file docutils literal notranslate"><span class="pre">FOO_wrap.cpp</span></code> or
<code class="file docutils literal notranslate"><span class="pre">FOO_wrapper.cpp</span></code>.</p></li>
<li><p>Header file documentation (aka docstrings) should be in Numpydoc
format. We don't plan on using automated tools for these
docstrings, and the Numpydoc format is well understood in the
scientific Python community.</p></li>
<li><p>C/C++ code in the <code class="file docutils literal notranslate"><span class="pre">extern/</span></code> directory is vendored, and should be kept
close to upstream whenever possible. It can be modified to fix bugs or
implement new features only if the required changes cannot be made elsewhere
in the codebase. In particular, avoid making style fixes to it.</p></li>
</ul>
</section>
<section id="keyword-argument-processing">
<span id="id14"></span><h3>Keyword argument processing<a class="headerlink" href="#keyword-argument-processing" title="Permalink to this heading">#</a></h3>
<p>Matplotlib makes extensive use of <code class="docutils literal notranslate"><span class="pre">**kwargs</span></code> for pass-through customizations
from one function to another. A typical example is
<a class="reference internal" href="../api/_as_gen/matplotlib.axes.Axes.text.html#matplotlib.axes.Axes.text" title="matplotlib.axes.Axes.text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">text</span></code></a>. The definition of <a class="reference internal" href="../api/_as_gen/matplotlib.pyplot.text.html#matplotlib.pyplot.text" title="matplotlib.pyplot.text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.pyplot.text</span></code></a> is a
simple pass-through to <a class="reference internal" href="../api/_as_gen/matplotlib.axes.Axes.text.html#matplotlib.axes.Axes.text" title="matplotlib.axes.Axes.text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.axes.Axes.text</span></code></a>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># in pyplot.py</span>
<span class="k">def</span> <span class="nf">text</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">fontdict</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="k">return</span> <span class="n">gca</span><span class="p">()</span><span class="o">.</span><span class="n">text</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">fontdict</span><span class="o">=</span><span class="n">fontdict</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p><a class="reference internal" href="../api/_as_gen/matplotlib.axes.Axes.text.html#matplotlib.axes.Axes.text" title="matplotlib.axes.Axes.text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.axes.Axes.text</span></code></a> (simplified for illustration) just
passes all <code class="docutils literal notranslate"><span class="pre">args</span></code> and <code class="docutils literal notranslate"><span class="pre">kwargs</span></code> on to <code class="docutils literal notranslate"><span class="pre">matplotlib.text.Text.__init__</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># in axes/_axes.py</span>
<span class="k">def</span> <span class="nf">text</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">s</span><span class="p">,</span> <span class="n">fontdict</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">t</span> <span class="o">=</span> <span class="n">Text</span><span class="p">(</span><span class="n">x</span><span class="o">=</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="o">=</span><span class="n">y</span><span class="p">,</span> <span class="n">text</span><span class="o">=</span><span class="n">s</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p>and <code class="docutils literal notranslate"><span class="pre">matplotlib.text.Text.__init__</span></code> (again, simplified)
just passes them on to the <a class="reference internal" href="../api/_as_gen/matplotlib.artist.Artist.update.html#matplotlib.artist.Artist.update" title="matplotlib.artist.Artist.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">matplotlib.artist.Artist.update</span></code></a> method:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># in text.py</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">y</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">text</span><span class="o">=</span><span class="s1">''</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">kwargs</span><span class="p">)</span>
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">update</span></code> does the work looking for methods named like
<code class="docutils literal notranslate"><span class="pre">set_property</span></code> if <code class="docutils literal notranslate"><span class="pre">property</span></code> is a keyword argument. i.e., no one
looks at the keywords, they just get passed through the API to the
artist constructor which looks for suitably named methods and calls
them with the value.</p>
<p>As a general rule, the use of <code class="docutils literal notranslate"><span class="pre">**kwargs</span></code> should be reserved for
pass-through keyword arguments, as in the example above. If all the
keyword args are to be used in the function, and not passed
on, use the key/value keyword args in the function definition rather
than the <code class="docutils literal notranslate"><span class="pre">**kwargs</span></code> idiom.</p>
<p>In some cases, you may want to consume some keys in the local
function, and let others pass through. Instead of popping arguments to
use off <code class="docutils literal notranslate"><span class="pre">**kwargs</span></code>, specify them as keyword-only arguments to the local
function. This makes it obvious at a glance which arguments will be
consumed in the function. For example, in
<a class="reference internal" href="../api/_as_gen/matplotlib.axes.Axes.plot.html#matplotlib.axes.Axes.plot" title="matplotlib.axes.Axes.plot"><code class="xref py py-meth docutils literal notranslate"><span class="pre">plot()</span></code></a>, <code class="docutils literal notranslate"><span class="pre">scalex</span></code> and <code class="docutils literal notranslate"><span class="pre">scaley</span></code> are
local arguments and the rest are passed on as
<a class="reference internal" href="../api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="matplotlib.lines.Line2D"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Line2D()</span></code></a> keyword arguments:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># in axes/_axes.py</span>
<span class="k">def</span> <span class="nf">plot</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="n">scalex</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">scaley</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="n">lines</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_lines</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_line</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
<span class="n">lines</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">line</span><span class="p">)</span>
</pre></div>
</div>
</section>
<section id="using-logging-for-debug-messages">
<span id="using-logging"></span><h3>Using logging for debug messages<a class="headerlink" href="#using-logging-for-debug-messages" title="Permalink to this heading">#</a></h3>
<p>Matplotlib uses the standard Python <a class="reference external" href="https://docs.python.org/3/library/logging.html#module-logging" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging</span></code></a> library to write verbose
warnings, information, and debug messages. Please use it! In all those places
you write <a class="reference external" href="https://docs.python.org/3/library/functions.html#print" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">print</span></code></a> calls to do your debugging, try using <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.debug" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.debug</span></code></a>
instead!</p>
<p>To include <a class="reference external" href="https://docs.python.org/3/library/logging.html#module-logging" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging</span></code></a> in your module, at the top of the module, you need to
<code class="docutils literal notranslate"><span class="pre">import</span> <span class="pre">logging</span></code>. Then calls in your code like:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">_log</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span> <span class="c1"># right after the imports</span>
<span class="c1"># code</span>
<span class="c1"># more code</span>
<span class="n">_log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Here is some information'</span><span class="p">)</span>
<span class="n">_log</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s1">'Here is some more detailed information'</span><span class="p">)</span>
</pre></div>
</div>
<p>will log to a logger named <code class="docutils literal notranslate"><span class="pre">matplotlib.yourmodulename</span></code>.</p>
<p>If an end-user of Matplotlib sets up <a class="reference external" href="https://docs.python.org/3/library/logging.html#module-logging" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging</span></code></a> to display at levels more
verbose than <code class="docutils literal notranslate"><span class="pre">logging.WARNING</span></code> in their code with the Matplotlib-provided
helper:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">plt</span><span class="o">.</span><span class="n">set_loglevel</span><span class="p">(</span><span class="s2">"debug"</span><span class="p">)</span>
</pre></div>
</div>
<p>or manually with</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">logging</span>
<span class="n">logging</span><span class="o">.</span><span class="n">basicConfig</span><span class="p">(</span><span class="n">level</span><span class="o">=</span><span class="n">logging</span><span class="o">.</span><span class="n">DEBUG</span><span class="p">)</span>
<span class="kn">import</span> <span class="nn">matplotlib.pyplot</span> <span class="k">as</span> <span class="nn">plt</span>
</pre></div>
</div>
<p>Then they will receive messages like</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>DEBUG:matplotlib.backends:backend MacOSX version unknown
DEBUG:matplotlib.yourmodulename:Here is some information
DEBUG:matplotlib.yourmodulename:Here is some more detailed information
</pre></div>
</div>
<section id="which-logging-level-to-use">
<h4>Which logging level to use?<a class="headerlink" href="#which-logging-level-to-use" title="Permalink to this heading">#</a></h4>
<p>There are five levels at which you can emit messages.</p>
<ul class="simple">
<li><p><a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.critical" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.critical</span></code></a> and <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.error" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.error</span></code></a> are really only there for errors that
will end the use of the library but not kill the interpreter.</p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.warning" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.warning</span></code></a> and <a class="reference internal" href="../api/_api_api.html#matplotlib._api.warn_external" title="matplotlib._api.warn_external"><code class="xref py py-obj docutils literal notranslate"><span class="pre">_api.warn_external</span></code></a> are used to warn the user,
see below.</p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.info" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.info</span></code></a> is for information that the user may want to know if the
program behaves oddly. They are not displayed by default. For instance, if
an object isn't drawn because its position is <code class="docutils literal notranslate"><span class="pre">NaN</span></code>, that can usually
be ignored, but a mystified user could call
<code class="docutils literal notranslate"><span class="pre">logging.basicConfig(level=logging.INFO)</span></code> and get an error message that
says why.</p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.debug" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.debug</span></code></a> is the least likely to be displayed, and hence can be the
most verbose. "Expected" code paths (e.g., reporting normal intermediate
steps of layouting or rendering) should only log at this level.</p></li>
</ul>
<p>By default, <a class="reference external" href="https://docs.python.org/3/library/logging.html#module-logging" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging</span></code></a> displays all log messages at levels higher than
<code class="docutils literal notranslate"><span class="pre">logging.WARNING</span></code> to <a class="reference external" href="https://docs.python.org/3/library/sys.html#sys.stderr" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sys.stderr</span></code></a>.</p>
<p>The <a class="reference external" href="https://docs.python.org/3/howto/logging.html#logging-basic-tutorial">logging tutorial</a> suggests that the difference between <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.warning" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.warning</span></code></a>
and <a class="reference internal" href="../api/_api_api.html#matplotlib._api.warn_external" title="matplotlib._api.warn_external"><code class="xref py py-obj docutils literal notranslate"><span class="pre">_api.warn_external</span></code></a> (which uses <a class="reference external" href="https://docs.python.org/3/library/warnings.html#warnings.warn" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">warnings.warn</span></code></a>) is that
<a class="reference internal" href="../api/_api_api.html#matplotlib._api.warn_external" title="matplotlib._api.warn_external"><code class="xref py py-obj docutils literal notranslate"><span class="pre">_api.warn_external</span></code></a> should be used for things the user must change to stop
the warning (typically in the source), whereas <a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.warning" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.warning</span></code></a> can be more
persistent. Moreover, note that <a class="reference internal" href="../api/_api_api.html#matplotlib._api.warn_external" title="matplotlib._api.warn_external"><code class="xref py py-obj docutils literal notranslate"><span class="pre">_api.warn_external</span></code></a> will by default only
emit a given warning <em>once</em> for each line of user code, whereas
<a class="reference external" href="https://docs.python.org/3/library/logging.html#logging.warning" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">logging.warning</span></code></a> will display the message every time it is called.</p>
<p>By default, <a class="reference external" href="https://docs.python.org/3/library/warnings.html#warnings.warn" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">warnings.warn</span></code></a> displays the line of code that has the <code class="docutils literal notranslate"><span class="pre">warn</span></code>
call. This usually isn't more informative than the warning message itself.
Therefore, Matplotlib uses <a class="reference internal" href="../api/_api_api.html#matplotlib._api.warn_external" title="matplotlib._api.warn_external"><code class="xref py py-obj docutils literal notranslate"><span class="pre">_api.warn_external</span></code></a> which uses <a class="reference external" href="https://docs.python.org/3/library/warnings.html#warnings.warn" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">warnings.warn</span></code></a>,
but goes up the stack and displays the first line of code outside of
Matplotlib. For example, for the module:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># in my_matplotlib_module.py</span>
<span class="kn">import</span> <span class="nn">warnings</span>
<span class="k">def</span> <span class="nf">set_range</span><span class="p">(</span><span class="n">bottom</span><span class="p">,</span> <span class="n">top</span><span class="p">):</span>
<span class="k">if</span> <span class="n">bottom</span> <span class="o">==</span> <span class="n">top</span><span class="p">:</span>
<span class="n">warnings</span><span class="o">.</span><span class="n">warn</span><span class="p">(</span><span class="s1">'Attempting to set identical bottom==top'</span><span class="p">)</span>
</pre></div>
</div>
<p>running the script:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">matplotlib</span> <span class="kn">import</span> <span class="n">my_matplotlib_module</span>
<span class="n">my_matplotlib_module</span><span class="o">.</span><span class="n">set_range</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span> <span class="c1"># set range</span>
</pre></div>
</div>
<p>will display</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>UserWarning: Attempting to set identical bottom==top
warnings.warn('Attempting to set identical bottom==top')
</pre></div>
</div>
<p>Modifying the module to use <a class="reference internal" href="../api/_api_api.html#matplotlib._api.warn_external" title="matplotlib._api.warn_external"><code class="xref py py-obj docutils literal notranslate"><span class="pre">_api.warn_external</span></code></a>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">matplotlib</span> <span class="kn">import</span> <span class="n">_api</span>
<span class="k">def</span> <span class="nf">set_range</span><span class="p">(</span><span class="n">bottom</span><span class="p">,</span> <span class="n">top</span><span class="p">):</span>
<span class="k">if</span> <span class="n">bottom</span> <span class="o">==</span> <span class="n">top</span><span class="p">:</span>
<span class="n">_api</span><span class="o">.</span><span class="n">warn_external</span><span class="p">(</span><span class="s1">'Attempting to set identical bottom==top'</span><span class="p">)</span>
</pre></div>
</div>
<p>and running the same script will display</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>UserWarning: Attempting to set identical bottom==top
my_matplotlib_module.set_range(0, 0) # set range
</pre></div>
</div>
</section>
</section>
<section id="writing-examples">