Skip to content
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

fix some docstring typos #1448

Closed
wants to merge 1 commit into from

Conversation

@jeis2497052
Copy link
Contributor

commented Feb 9, 2018

are these OK?

@basil-conto

This comment has been minimized.

Copy link
Collaborator

commented Feb 9, 2018

are these OK?

LGTM.

@basil-conto

This comment has been minimized.

Copy link
Collaborator

commented Feb 9, 2018

Actually, I would reword the commit message as "Fix some docstring typos".

@jeis2497052 jeis2497052 changed the title Propose fixing some typos Propose fix some docstring typos Feb 9, 2018

@jeis2497052

This comment has been minimized.

Copy link
Contributor Author

commented Feb 9, 2018

should I amend the git commit ?

@jeis2497052 jeis2497052 force-pushed the jeis2497052:master branch Feb 9, 2018

@jeis2497052

This comment has been minimized.

Copy link
Contributor Author

commented Feb 9, 2018

did I amend the git commit string properly ?

@basil-conto

This comment has been minimized.

Copy link
Collaborator

commented Feb 9, 2018

should I amend the git commit ?

I'm not the owner, so I can't force you, but FWIW I think the word "propose" makes no sense in a commit message. The commit was either merged, or it wasn't. It either fixed the typos, or it didn't. :)

@jeis2497052

This comment has been minimized.

Copy link
Contributor Author

commented Feb 9, 2018

sorry, I will remove propose then

@jeis2497052 jeis2497052 changed the title Propose fix some docstring typos fix some docstring typos Feb 9, 2018

@basil-conto

This comment has been minimized.

Copy link
Collaborator

commented Feb 9, 2018

@jeis2497052 I'm talking about the message of your git commit 6a0d1fd, not the GitHub PR title.

@jeis2497052 jeis2497052 force-pushed the jeis2497052:master branch to c049789 Feb 9, 2018

@jeis2497052

This comment has been minimized.

Copy link
Contributor Author

commented Feb 9, 2018

got it, just amended

@basil-conto

This comment has been minimized.

Copy link
Collaborator

commented Feb 9, 2018

Thanks, and sorry for the pedantry. :)

@jeis2497052

This comment has been minimized.

Copy link
Contributor Author

commented Feb 9, 2018

I just want to contribute as I like using swiper and each repo has some nuance regarding PR.

@basil-conto

This comment has been minimized.

Copy link
Collaborator

commented Feb 9, 2018

I just want to contribute as I like using swiper and each repo has some nuance regarding PR.

Sorry, I didn't mean to deter you (I'm not even a maintainer here!). My comment was only intended as a friendly and constructive suggestion to make the life of swiper's maintainers easier.

In general, though, the "nuances" of different FOSS projects aren't completely unjustified. Successfully maintaining these projects is very hard work and so maintainers often set up guidelines for a certain quality standard and for consistency which will make their life easier. See also https://windsooon.github.io/2017/11/23/Why%20we%20never%20thank%20open%20source%20maintainers/.

Anyway, thanks for catching these typos (one of which I'm responsible for)!

@jeis2497052

This comment has been minimized.

Copy link
Contributor Author

commented Feb 9, 2018

last thing I want is to contribute to additional work for any maintainer. I suppose I could have read commits to guess a little better. I have happy for follow your guidelines. Good link regarding the life of a maintainer. I can't image it.

@abo-abo abo-abo closed this in c9e5ea3 Feb 9, 2018

@abo-abo

This comment has been minimized.

Copy link
Owner

commented Feb 9, 2018

Thanks. I really should run ispell at least once through the whole code base, I have no ieda where all these typeos are coming from:)

@jeis2497052

This comment has been minimized.

Copy link
Contributor Author

commented Feb 9, 2018

no worries, I am the worst speller and live by ispell :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.