Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Many docstring cleanups. #17150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 15, 2020
Merged

Many docstring cleanups. #17150

merged 1 commit into from
Apr 15, 2020

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Apr 15, 2020

Mostly D401 ("imperative mood"), and a few others.

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

@anntzer anntzer added this to the v3.3.0 milestone Apr 15, 2020
@@ -287,7 +286,7 @@ def _interpolate_single_key(self, return_key, tri_index, x, y):

class CubicTriInterpolator(TriInterpolator):
r"""
A CubicTriInterpolator performs cubic interpolation on triangular grids.
Cubic interpolator on triangular grids.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Cubic interpolator on triangular grids.
Cubic interpolator on a triangular grid.

Like in LinearTriInterpolator above.

Copy link
Member

@timhoffm timhoffm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor issue. Anybody can merge after fixing it.

@anntzer
Copy link
Contributor Author

anntzer commented Apr 15, 2020

handled, and put in a few more.

@@ -192,7 +192,7 @@ def _ensure_handler():

def set_loglevel(level):
"""
Sets the Matplotlib's root logger and root logger handler level, creating
Set the Matplotlib's root logger and root logger handler level, creating
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Set the Matplotlib's root logger and root logger handler level, creating
Set Matplotlib's root logger and root logger handler level, creating

Combines an rgb image with an intensity map using "soft light"
blending. Uses the "pegtop" formula.
Combine an rgb image with an intensity map using "soft light" blending,
with the "pegtop" formula.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
with the "pegtop" formula.
using the "pegtop" formula.

Copy link
Member

@jklymak jklymak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...aside from one grammar mistake, and one suggestion

Mostly D401 ("imperative mood"), and a few others.
@anntzer
Copy link
Contributor Author

anntzer commented Apr 15, 2020

handled

@jklymak jklymak merged commit e39c67b into matplotlib:master Apr 15, 2020
@anntzer anntzer deleted the d401 branch April 15, 2020 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.