whitespace(-mostly) style cleanup. #12026

anntzer · 2018-09-05T14:23:46Z

I intentionally left in nearly all commented out dead code.

PR Summary

PR Checklist

Has Pytest style unit tests
Code is Flake 8 compliant
New features are documented, with examples if plot related
Documentation is sphinx and numpydoc compliant
Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

I intentionally left in nearly all commented out dead code.

anntzer · 2018-09-05T14:24:11Z

lib/mpl_toolkits/axisartist/angle_helper.py

@@ -295,7 +297,7 @@ def __call__(self, direction, factor, values):
                l_hm = self.fmt_d_m_partial % (s, d1, m1)
                if l_hm != l_hm_old:
                    l_hm_old = l_hm
-                    l = l_hm + s1 #l_s


l_s doesn't appear anywhere else in the codebase so I just killed the comment.

phobson

i think the commented out code in general should be removed, but i understand why we'd want to keep it around.

phobson · 2018-09-05T17:26:01Z

lib/mpl_toolkits/axisartist/floating_axes.py

-            #dd += np.pi
-            #dd = np.arctan2(xx2-xx1, angle_tangent-yy1)
+            # dd += np.pi
+            # dd = np.arctan2(xx2-xx1, angle_tangent-yy1)


should these just go away?

The whole block came in commented out with the surrounding code in 4fa9271 so yes.

phobson · 2018-09-05T17:26:29Z

lib/mpl_toolkits/axisartist/floating_axes.py

@@ -245,30 +235,21 @@ def __init__(self, aux_trans, extremes,
                         tick_formatter1=tick_formatter1,
                         tick_formatter2=tick_formatter2)

-


should these go away as well?

there's an update_grid_finder in grid_helper_curvelinear so I'll leave this one in

phobson · 2018-09-05T17:27:36Z

lib/mpl_toolkits/axisartist/floating_axes.py

        lon_lines, lat_lines = grid_finder._get_raw_grid_lines(extremes[:2],
                                                               extremes[2:],
                                                               *extremes)
-        #lon_min, lon_max,
+        # lon_min, lon_max,
        #                                                       lat_min, lat_max)


perhaps this should be bumped up to previous line

phobson · 2018-09-05T17:28:07Z

lib/mpl_toolkits/axisartist/grid_helper_curvelinear.py

@@ -140,7 +138,7 @@ def update_lim(self, axes):

        grid_finder = self.grid_helper.grid_finder

-        #e1, e2 = self._extremes # ranges of other coordinates
+        # e1, e2 = self._extremes # ranges of other coordinates


duplicated just a bit before in the same function so yes

phobson · 2018-09-05T17:28:24Z

lib/mpl_toolkits/axisartist/grid_helper_curvelinear.py

+            # dd = np.arctan2(yy2-yy1, xx2-xx1) # angle normal
+            # dd2 = np.arctan2(yy3-yy1, xx3-xx1) # angle tangent
+            # mm = ((yy2-yy1)==0.) & ((xx2-xx1)==0.) # mask where dd1 is not defined
+            # dd[mm] = dd2[mm] + np.pi / 2


came in commented in 3b48ebb, and there's no yy2 and friends as local variables anymore, so I guess sure.

anntzer · 2018-09-05T17:36:32Z

I agree with removing dead code in general, but I think someone should first figure out what a given line was intended to do before killing it.

WeatherGod · 2018-09-05T17:41:23Z

I really don't like it when auto-linters add that space for blocks of commented out code. It doesn't make it any easier for me to read, and it actually makes it harder to distinguish an expression that lives in a comment, versus some actual, previously used but now commented out code.

…

On Wed, Sep 5, 2018 at 1:36 PM Antony Lee ***@***.***> wrote: I agree with removing dead code in general, but I think someone should first figure out what a given line was intended to do before killing it. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#12026 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AARy-BWN91QcCeVLg-XGYwgk2FzaZFl7ks5uYAuhgaJpZM4WbBbG> .

anntzer · 2018-09-05T17:54:52Z

I hadn't heard of the "if there's no space after the hash it's commented out code" convention; I guess it could be a valuable one but we're already far from doing that in the rest of the codebase (yes, this PR makes things "worse" in that respect).
(Also that's basically arguing "we don't care about this specific item of the style guide", which is fine but another discussion...)

timhoffm

Marked some obviously stale commented code segments. There are probably more, but I didn't want to check all right now. Even without these, this is an improvement.

Technically it's better to check them now and remove them instead of reformatting them. Reformatting makes it harder to go back in history and find out why the code was commented in the first place.

timhoffm · 2018-09-05T21:59:40Z

lib/mpl_toolkits/axes_grid1/colorbar.py

@@ -600,11 +583,10 @@ def _select_locator(self, formatter):
                locator = ticker.MaxNLocator(nbins=5)
        else:
            b = self._boundaries[self._inside]
-            locator = ticker.FixedLocator(b) #, nbins=10)
+            locator = ticker.FixedLocator(b)  # nbins=10)


This comment can be removed completely as it was just commented out code.

timhoffm · 2018-09-05T22:03:17Z

lib/mpl_toolkits/axisartist/angle_helper.py

-        #self.transform_xy = transform_xy
-        #self.inv_transform_xy = inv_transform_xy
+        # self.transform_xy = transform_xy
+        # self.inv_transform_xy = inv_transform_xy


Stale commented code. Should be removed.

timhoffm · 2018-09-05T22:04:20Z

lib/mpl_toolkits/axisartist/axislines.py

                    c[self.nth_coord] = x

                    # check if the tick point is inside axes
                    c2 = tr2ax.transform_point(c)
-                    #delta=0.00001
+                    # delta=0.00001


Stale code comment?

timhoffm · 2018-09-05T22:05:09Z

lib/mpl_toolkits/axisartist/floating_axes.py

        super().__init__(grid_helper, nth_coord, value, axis_direction=side)
-        #self.grid_helper = grid_helper
+        # self.grid_helper = grid_helper


Stale code comment. Remove.

timhoffm · 2018-09-05T22:06:24Z

lib/mpl_toolkits/axisartist/floating_axes.py

@@ -123,7 +116,7 @@ def transform_xy(x, y):
            xx0 = np.empty_like(yy0)
            xx0.fill(self.value)

-            #yy0_ = yy0.copy()
+            # yy0_ = yy0.copy()


Stale code comment. Remove.

timhoffm · 2018-09-05T22:06:31Z

lib/mpl_toolkits/axisartist/floating_axes.py

@@ -144,10 +137,9 @@ def transform_xy(x, y):
            yy0 = np.empty_like(xx0)
            yy0.fill(self.value)

-            #xx0_ = xx0.copy()
+            # xx0_ = xx0.copy()


Stale code comment. Remove.

timhoffm · 2018-09-05T22:08:31Z

lib/mpl_toolkits/axisartist/floating_axes.py

    def adjust_axes_lim(self):

-        #t = self.get_boundary()
+        # t = self.get_boundary()


Stale code comment. Remove.

anntzer · 2018-09-05T22:45:08Z

All cases you pointed out look reasonable (except perhaps FixedLocator(nbins=10) because who knows whether there was a real need to set nbins=10, OTOH that just seems unlikely), removed them all.

Whitespace style cleanup.

8280954

I intentionally left in nearly all commented out dead code.

anntzer commented Sep 5, 2018

View reviewed changes

phobson approved these changes Sep 5, 2018

View reviewed changes

Kill some commented out code.

eb30e45

timhoffm approved these changes Sep 5, 2018

View reviewed changes

And some more.

4633cbd

jklymak merged commit 1a40221 into matplotlib:master Sep 6, 2018

anntzer deleted the style branch September 6, 2018 21:44

QuLogic added this to the v3.1 milestone Sep 6, 2018

		@@ -245,30 +235,21 @@ def __init__(self, aux_trans, extremes,
		tick_formatter1=tick_formatter1,
		tick_formatter2=tick_formatter2)

Uh oh!

whitespace(-mostly) style cleanup. #12026

whitespace(-mostly) style cleanup. #12026

Uh oh!

Conversation

anntzer commented Sep 5, 2018

PR Summary

PR Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

phobson left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anntzer Sep 5, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anntzer commented Sep 5, 2018

Uh oh!

WeatherGod commented Sep 5, 2018 via email

Uh oh!

anntzer commented Sep 5, 2018

Uh oh!

timhoffm left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anntzer commented Sep 5, 2018

Uh oh!

Uh oh!

anntzer Sep 5, 2018 •

edited

Loading

timhoffm left a comment •

edited

Loading