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

A few grammatical improvements #839

Closed
wants to merge 1 commit into from

Conversation

zoffixznet
Copy link
Contributor

Most of these are just fixed comma splices.

Please review.

The easiest way to make placeholders more restrictive are alternatives, you
just make a list of possible values.
The easiest way to make placeholders more restrictive is to use
alternatives: you just make a list of possible values.
Copy link
Member

Choose a reason for hiding this comment

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

this would be a semi-colon I believe, as many of these suggestions could also be

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I feel a colon is more appropriate, as the second clause is not only related, but expounds the first clause. And yes, semicolons can be used to fix some of the comma splices, but I think in technical documentation that would feel a bit clunky, compared to concise, simple sentences.

Copy link
Member

Choose a reason for hiding this comment

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

English is not my native language, but the colon looks odd to me.

Copy link
Contributor

Choose a reason for hiding this comment

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

I could see either way, but I would err on the side of semi-colon in this case.

@zoffixznet
Copy link
Contributor Author

I have a "Grammatically Correct 2", as well as Strunk and White's style guide laying around somewhere. If you'd like, I could locate those books tomorrow and provide more support for my grammatical suggestions. I intend to read all of Mojo docs this month, so there are more PRs like this to come. Let me know.

@jberger
Copy link
Member

jberger commented Sep 5, 2015

Strunk and White may be a bit much, but I haven't used full colons in that
way. That said this (from a quick google) seems to support it:
http://www2.le.ac.uk/offices/ld/resources/writing/grammar/grammar-guides/semicolon

On Sat, Sep 5, 2015 at 2:30 PM Zoffix Znet notifications@github.com wrote:

I have a "Grammatically Correct 2", as well as Strunk and White's style
guide laying around somewhere. If you'd like, I could locate those books
tomorrow and provide more support for my grammatical suggestions. I intend
to read all of Mojo docs this month, so there are more PRs like this to
come. Let me know.


Reply to this email directly or view it on GitHub
#839 (comment).

@zoffixznet
Copy link
Contributor Author

Very well :)

Let me know how I can amend this PR to make it acceptable for merging and I shall do so when I get home.

@jberger
Copy link
Member

jberger commented Sep 5, 2015

I guess what I'm saying is, it is technically acceptable as-is, though I
wouldn't have written it that way myself.

On Sat, Sep 5, 2015 at 4:19 PM Zoffix Znet notifications@github.com wrote:

Very well :)

Let me know how I can amend this PR to make it acceptable for merging and
I shall do so when I get home.


Reply to this email directly or view it on GitHub
#839 (comment).

@zoffixznet
Copy link
Contributor Author

I've changed the colon to semi-colon, based on the feedback from the group. Let me know if any other changes are needed.

The easiest way to make placeholders more restrictive are alternatives, you
just make a list of possible values.
The easiest way to make placeholders more restrictive is to use
alternatives; you just make a list of possible values.
Copy link
Member

Choose a reason for hiding this comment

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

Looks like you did not check the line length after making changes.

@kraih
Copy link
Member

kraih commented Sep 7, 2015

My english is not good enough to judge the actual changes, but i'm afraid i have to vote 👎 for formatting issues.

@zoffixznet zoffixznet closed this Sep 7, 2015
@zoffixznet
Copy link
Contributor Author

As I've mentioned, I found more similiar corrections to make, as well as a few grammaticall errors in words in other docs in Mojolicious distro.

I'll add these changes to others when I'm done with all the docs and submit a new PR.

@kraih is right, I did not run the code through perltidy. I'll need to learn how to do that :)

@jhthorsen
Copy link
Member

@zoffixznet:

$ cpanm App::githook::perltidy
$ cd mojo
$ githook-perltidy install
# do changes and perltidy is run on commit

@kraih
Copy link
Member

kraih commented Sep 7, 2015

Perltidy does not work for documentation, you'll have to check every line manually.

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.

5 participants