Add support for ax.locator_params() #126
Conversation
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## main #126 +/- ##
==========================================
- Coverage 93.10% 91.78% -1.32%
==========================================
Files 1 1
Lines 203 207 +4
Branches 47 47
==========================================
+ Hits 189 190 +1
- Misses 7 10 +3
Partials 7 7
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
|
Nice, thanks @sjsmith757 -- to eventually merge this we'll probably want to add a test or two of this new functionality. No worries though if you're too busy to look into that at the moment. |
|
Hi @spencerkclark - I've added some unit tests for my new method, as well as one integration test to ensure users can call it simply using the pyplot interface and that the functionality works in the larger context. I think using the |
There was a problem hiding this comment.
Thanks @sjsmith757 -- looks great -- just a few really minor suggestions.
It actually would be nice if you could add a one-line docstring for set_params since it will show up in the documentation of the NetCDFTimeDateLocator class (see the table of methods here). Maybe it could link to the MaxNLocator documentation page via :py:class:`matplotlib.ticker.MaxNLocator` as a source for the possible keyword arguments to pass, since this otherwise might be tricky to track down.
Finally, please give yourself credit with a note in the latest "New Features" section of the Release Notes.
| def set_params(self, **kwargs): | ||
| self._max_n_locator_days.set_params(**kwargs) | ||
| self._max_n_locator.set_params(**kwargs) | ||
| return |
| # Add more assertions to test the behavior of the method | ||
| # For example, you can assert that the internal state of the locator is updated correctly | ||
| self.assertEqual( | ||
| getattr(locator._max_n_locator_days, f"_{key}"), value | ||
| ) | ||
| self.assertEqual( | ||
| getattr(locator._max_n_locator, f"_{key}"), value | ||
| ) |
There was a problem hiding this comment.
I could go either way on including these checks. They are a nice explicit way of checking that the set_params method worked as expected, though they depend on private attributes of the MaxNLocator class. I'm not sure if anyone else has opinions.
|
|
🚀 Pull Request
Description
Added the
set_paramsmethod to theNetCDFTimeDateLocatorclass to support updating the number of ticks after the nc-time-axis is created. This allows for the locator parameters of the underlying AutoLocator to be modified. A full list of available parameters is here.This can be done using
plt.locator_params(axis='x')as the simplest orplt.gca().xaxis.get_major_locator().set_params()as a more fine-tuned alternative, assuming the time axis is the x axis.Fixes #20