Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Minor typo in the docstring of IdentityTransform? #6680

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.

Sign up for GitHub

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

Jump to bottom
Closed
afvincent opened this issue Jul 3, 2016 · 6 comments
Closed

Minor typo in the docstring of IdentityTransform? #6680

afvincent opened this issue Jul 3, 2016 · 6 comments
Assignees
@afvincent
Labels
Documentation
Milestone
v2.0.0

Comments

@afvincent
Copy link
Contributor

In transforms.py, I'm wondering if there wouldn't be a minor typo in this docstring:

class IdentityTransform(Affine2DBase):
    """
    A special class that does on thing, the identity transform, in a
    fast way.
    """

Shouldn't it be something like … that does on*e* thing,… or … that does nothing,…?
@tacaswell
Copy link
Member

I think it should be 's/on/one/'.

@afvincent
Copy link
Contributor Author

Naive question: how do we know which milestone to target?

Besides I opened the PR #6681 to fix the typo. As Travis & Co are green, I guess the next step is merging it, or is it expected to wait for someone else to review it? It's a one-character change in a docstring but I prefer asking.

jenshnielsen added a commit that referenced this issue Jul 3, 2016
@jenshnielsen
Merge pull request #6681 from afvincent/Typo_in_IdentityTransform_doc…
e5e0838 
…string

Fix #6680 (minor typo in IdentityTransform docstring)
@jenshnielsen
Copy link
Member

@afvincent I merged #6681 now and backported it to the 2.x branch normally we try to avoid self merges but in this case I think it would be ok as the change is really small and @tacaswell has suggested the same change here

@jenshnielsen
Copy link
Member

There is no general rule for the mile stoning but as this is a very low risk change that fixes a clear typo it should clearly go in the bugfix release. It could have gone into 1.5.2 but I think @tacaswell is in the progress of tagging that now so I only backported it to 2.x

@tacaswell
Copy link
Member

Just pushed the 1.5.2 tag 😄 .

@afvincent
Copy link
Contributor Author

@jenshnielsen Thanks for the explanations, it was more or less what I had understood. (BTW backporting the fix "only" to 2.x is perfectly fine to me.)

@QuLogic QuLogic added this to the 2.0 (style change major release) milestone Jul 3, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@afvincent afvincent

Labels
Documentation
Projects
None yet
Milestone
v2.0.0
Development

No branches or pull requests
5 participants
@mdboom @tacaswell @QuLogic @jenshnielsen @afvincent