Merge pull request #252 from lukelbd/default-transparent-false

lukelbd · web-flow · commit fa779018ca06 · 2021-06-29T16:59:02.000-06:00
Return default savefig transparency to False
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -69,6 +69,9 @@ ProPlot v0.7.0 (2021-06-30)
 
 .. rubric:: Deprecated
 
+* Change default :rcraw:`savefig.transparent` back to ``False`` (:pr:`252`). Dubious
+  justification for ``True`` in the first place, and makes default PNG proplot figures
+  unreadable wherever "dark mode" is enabled.
 * Rename `SciVisColor` colormaps from ``Blue1``, ``Blue2``, etc. to plurals ``Blues1``,
   ``Blues2``, etc. to avoid name conflict with open-color colors. This permits making
   monochromatic open-color maps with e.g. ``plot.Colormap('blue9')``, and feels more
diff --git a/docs/basics.py b/docs/basics.py
@@ -55,11 +55,8 @@
 #    `matplotlib backend <https://matplotlib.org/faq/usage_faq#what-is-a-backend>`__
 #    -- the default background color is white when the figure is saved. This is done
 #    by setting :rcraw:`figure.facecolor` to gray, in order to improve contrast
-#    when working with figures.
-#    ProPlot also makes the default saved figure background *transparent*
-#    by setting :rcraw:`savefig.transparent` to ``True``
-#    and changes the default :rcraw:`savefig.format` from PNG to PDF
-#    for the following reasons:
+#    when working with figures, similar to MATLAB. ProPlot also changes the default
+#    :rcraw:`savefig.format` from PNG to PDF for the following reasons:
 #
 #        #. Vector graphic formats are infinitely scalable.
 #        #. Vector graphic formats are preferred by academic journals.
diff --git a/docs/projections.py b/docs/projections.py
@@ -142,7 +142,7 @@
 #
 #    * ProPlot ensures that polar cartopy projections like
 #      `~cartopy.crs.NorthPolarStereo` have circular boundaries (see `this example\
-#      <https://scitools.org.uk/cartopy/docs/latest/gallery/always_circular_stereo>`__
+#      <https://scitools.org.uk/cartopy/docs/latest/gallery/lines_and_polygons/always_circular_stereo.html>`__
 #      from the cartopy website).
 #    * By default, non-polar cartopy projections are forced to have global extent
 #      with `~cartopy.mpl.geoaxes.GeoAxes.set_global` and polar cartopy projections
diff --git a/proplot/figure.py b/proplot/figure.py
@@ -1262,7 +1262,7 @@ def save(self, filename, **kwargs):
         return self.savefig(filename, **kwargs)
 
     def savefig(self, filename, **kwargs):
-        # Automatically expand user the user name. Undocumented because we
+        # Automatically expand the user name. Undocumented because we
         # do not want to overwrite the matplotlib docstring.
         # TODO: Concatenate docstrings.
         if isinstance(filename, str):
diff --git a/proplot/internals/rcsetup.py b/proplot/internals/rcsetup.py
@@ -208,7 +208,7 @@
     'savefig.dpi': 1200,  # academic journal recommendations for raster line art
     'savefig.facecolor': 'white',  # different from figure.facecolor
     'savefig.format': 'pdf',  # most users use bitmap, but vector graphics are better
-    'savefig.transparent': True,
+    'savefig.transparent': False,
     'xtick.direction': TICKDIR,
     'xtick.labelsize': LABELSIZE,
     'xtick.major.pad': TICKPAD,

Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,9 @@ ProPlot v0.7.0 (2021-06-30)`
`69`	`69`
`70`	`70`	`.. rubric:: Deprecated`
`71`	`71`
	`72`	+* Change default :rcraw:`savefig.transparent` back to ``False`` (:pr:`252`). Dubious
	`73`	+ justification for ``True`` in the first place, and makes default PNG proplot figures
	`74`	`+ unreadable wherever "dark mode" is enabled.`
`72`	`75`	* Rename `SciVisColor` colormaps from ``Blue1``, ``Blue2``, etc. to plurals ``Blues1``,
`73`	`76`	``Blues2``, etc. to avoid name conflict with open-color colors. This permits making
`74`	`77`	monochromatic open-color maps with e.g. ``plot.Colormap('blue9')``, and feels more
Original file line number	Diff line number	Diff line change
`@@ -142,7 +142,7 @@`
`142`	`142`	`#`
`143`	`143`	`# * ProPlot ensures that polar cartopy projections like`
`144`	`144`	# `~cartopy.crs.NorthPolarStereo` have circular boundaries (see `this example\
`145`		-# <https://scitools.org.uk/cartopy/docs/latest/gallery/always_circular_stereo>`__
	`145`	+# <https://scitools.org.uk/cartopy/docs/latest/gallery/lines_and_polygons/always_circular_stereo.html>`__
`146`	`146`	`# from the cartopy website).`
`147`	`147`	`# * By default, non-polar cartopy projections are forced to have global extent`
`148`	`148`	# with `~cartopy.mpl.geoaxes.GeoAxes.set_global` and polar cartopy projections