Skip to content

Remove some extra spaces in docstrings/comments.#11592

Merged
jklymak merged 1 commit into
matplotlib:masterfrom
anntzer:spacesindocstrings
Jul 7, 2018
Merged

Remove some extra spaces in docstrings/comments.#11592
jklymak merged 1 commit into
matplotlib:masterfrom
anntzer:spacesindocstrings

Conversation

@anntzer

@anntzer anntzer commented Jul 6, 2018

Copy link
Copy Markdown
Contributor

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is PEP 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

@jklymak jklymak left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

.... I'm not going to ask how you found all these...

@jklymak jklymak merged commit 258ad31 into matplotlib:master Jul 7, 2018
@jklymak

jklymak commented Jul 7, 2018

Copy link
Copy Markdown
Member

Merging because I don't think any code was touched...

@afvincent afvincent left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Huh, it looks like @jklymak was faster than I was ^^... I do not think that the two extra notes I have left are really worth it as the PR has already been merged: there are very (very) minor suggestions ;).

Comment thread lib/matplotlib/patches.py

def get_width(self):
"Return the width of the rectangle"
"Return the width of the rectangle"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Add a final period ? As you seem to have added it to other docstrings (at least one) 😈.

angle = np.abs(np.mod((alpha2-alpha1) / np.pi, 1.))
# Weight proportional to angle up np.pi/2 ; null weight for
# Weight proportional to angle up np.pi/2; null weight for
# degenerated cases 0. and np.pi (Note that `angle` is normalized

@afvincent afvincent Jul 7, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Being there "degenerated cases 0 and np.pi (note that angle is normalized"?

@jklymak

jklymak commented Jul 7, 2018

Copy link
Copy Markdown
Member

.... sorry

@afvincent

Copy link
Copy Markdown
Contributor

@jklymak No problem 😄. (BTW, I would be interested to know how all those extra spaces were found ^^...)

@anntzer

anntzer commented Jul 7, 2018

Copy link
Copy Markdown
Contributor Author

I noticed one while checking the signature of cbook.deprecated (for #11590). Then it just a matter of grepping for \w \.?;? \w...

@anntzer anntzer deleted the spacesindocstrings branch July 7, 2018 09:29
@anntzer anntzer mentioned this pull request Jul 7, 2018
6 tasks
@tacaswell tacaswell added this to the v3.0 milestone Jul 7, 2018
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.

4 participants