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 typos in README.md #820

Merged
merged 1 commit into from
Sep 1, 2016
Merged

Fix typos in README.md #820

merged 1 commit into from
Sep 1, 2016

Conversation

slel
Copy link
Contributor

@slel slel commented Apr 3, 2016

File -> Filing, hestitate -> hesitate

@coveralls
Copy link

Coverage Status

Coverage remained the same at 63.054% when pulling 454dcc3 on slel:patch-2 into 91fb468 on dcjones:master.

@@ -219,9 +219,9 @@ to be included inline in the HTML page, or included with an object tag, like.

# Reporting Bugs

This is a new and fairly complex piece of software. [File an
This is a new and fairly complex piece of software. [Filing an
Copy link
Collaborator

Choose a reason for hiding this comment

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

this should have remained "File"?

@tlnagy tlnagy closed this Sep 1, 2016
@slel
Copy link
Contributor Author

slel commented Sep 1, 2016

Which one sounds correct?

File an issue is extremely valuable in helping me prioritize what to work on.
Filing an issue is extremely valuable in helping me prioritize what to work on.

@tlnagy tlnagy reopened this Sep 1, 2016
@tlnagy
Copy link
Member

tlnagy commented Sep 1, 2016

You're right. I wasn't careful when reading, the second sounds better. It isn't the best worded sentence.

@tlnagy tlnagy merged commit 80ac5eb into GiovineItalia:master Sep 1, 2016
@slel slel deleted the patch-2 branch September 1, 2016 20:53
@slel
Copy link
Contributor Author

slel commented Sep 1, 2016

The same sentence is at the end of http://gadflyjl.org which uses
https://github.com/dcjones/Gadfly.jl/blob/master/doc/index.md
(that page has a number of typos too, I'll send a pull request).

@slel
Copy link
Contributor Author

slel commented Sep 1, 2016

In fact, the sentence was correct up until this commit,
arising from a misunderstanding of its syntax:
f8ec68d

@tlnagy
Copy link
Member

tlnagy commented Sep 1, 2016 via email

@tlnagy
Copy link
Member

tlnagy commented Sep 1, 2016 via email

@slel
Copy link
Contributor Author

slel commented Sep 1, 2016

Okay. Maybe splitting the long sentence, that some found confusing,
into shorter sentences, as below, would decrease confusion:

This is a fairly complex piece of software.

Please [file an issue] to report any bug or counterintuitive behavior,
or even to request a feature.

This is extremely valuable in helping prioritize what to work on, so don't hesitate.

(with a link from "file an issue" to https://github.com/dcjones/Gadfly.jl/issues).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants